Sync Open Api document
1 min
POST
https://api.archbee.com/api/public-api/sync-api-reference
acceptstringGenerated from available response content types
Content-Typestring
docTreeIdstring<p>OPTIONAL, main category id where open api was imported; if undefined, a new docTree is created and its id is returned</p>
filefile<p>Open api file, .json or .yml or .yaml or .zip</p>
typestring<openapi | postman>Type of import file. Default openapi
openApiTryItstring<true | false>OPTIONAL. You can now test your API's directly in the editor or on your published docs with the new API Try It!
openApiUseOwnBackendstring<true | false><p>OPTIONAL. When 'Try It' is enabled, send requests directly from the browser to the URL defined in the OpenAPI spec instead of proxying through Archbee. Requires CORS configured on your backend.</p>
showDownloadOpenApiFilestring<true | false><p>OPTIONAL. You can show/hide the download link of the imported Open API file in the Open API tree.</p>
shouldCreateSchemaCategorystring<true | false>OPTIONAL. You can create models category to display all your models.
shouldCreateIntrostring<true | false>OPTIONAL. You can create an additional document to display open api intro.
openApiLanguageExampleslistOPTIONAL. Add your custom language examples. Maximum 5 programming language examples are allowed!
200Import OK status
400Invalid request
curl --request POST \
--url https://api.archbee.com/api/public-api/sync-api-reference \
--header 'accept: application/json' \
--header 'content-type: multipart/form-data' \
--form 'docTreeId="21-character__string0"' \
--form 'file=@"/path/to/file"' \
--form 'type="openapi"' \
--form 'openApiTryIt="true"' \
--form 'openApiUseOwnBackend="true"' \
--form 'showDownloadOpenApiFile="true"' \
--form 'shouldCreateSchemaCategory="true"' \
--form 'shouldCreateIntro="true"'Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.