archive/bramw_baserow
1
0
Fork 0
mirror of https://gitlab.com/bramw/baserow.git synced 2025-05-17 22:32:02 +00:00
Code Issues Projects Releases Wiki Activity

Resolve "Add user file upload docs to the generated API docs"

Browse source
This commit is contained in:
Peter Evans 2022-09-07 11:29:51 +00:00 • committed by Nigel Gott
parent f893a027bd
commit e3ecce1de7
11 changed files with 522 additions and 8 deletions
web-frontend/modules/database/components/docs
APIDocsExample.vue

35
web-frontend/modules/database/components/docs/APIDocsExample.vue
View file

@ -165,6 +165,11 @@ export default {
required: false,
default: '',
},
fileRequest: {
type: String,
required: false,
default: '',
},
request: {
type: [Object, Boolean],
required: false,
@ -226,6 +231,11 @@ export default {
example += '\n-H "Content-Type: application/json" \\'
}
if (this.fileRequest !== '') {
index++
example += ` \\\n-F file=@${this.fileRequest}`
}
example += `\n${this.url}`
if (this.request !== false) {
@ -250,6 +260,12 @@ export default {
example += `${this.url} HTTP`
example += '\nAuthorization: Token YOUR_API_KEY'
if (this.fileRequest !== '') {
example += '\nContent-Length: YOUR_CONTENT_LENGTH'
example +=
'\nContent-Type: multipart/form-data; boundary=------------------------YOUR_BOUNDARY'
}
if (this.request !== false) {
index += 2
example += '\nContent-Type: application/json'
@ -263,7 +279,14 @@ export default {
},
getJavaScriptExample() {
let index = 5
let example = 'axios({'
let example = ''
if (this.fileRequest !== '') {
example += 'const formData = new FormData()'
example += `\nformData.append('file', '${this.fileRequest}')`
example += "\naxios.post('/fileupload', formData, {"
} else {
example = 'axios({'
}
if (this.type !== '') {
index++
@ -274,6 +297,11 @@ export default {
example += '\n headers: {'
example += '\n Authorization: "Token YOUR_API_KEY"'
if (this.fileRequest !== '') {
index++
example += ',\n "Content-Type": "multipart/form-data"'
}
if (this.request !== false) {
index++
example += ',\n "Content-Type": "application/json"'
@ -309,6 +337,11 @@ export default {
example += '\n }'
if (this.fileRequest !== '') {
index++
example += `\n files={'file': open('${this.fileRequest}', 'rb')}`
}
if (this.request !== false) {
index++
const data = this.format(this.request).split('\n').join('\n ')