...
With Swagger Editor, you can view and edit the OpenAPI document inside your browser, while previewing the documentation in real time.
Visit https://editor-next.swagger.io/ and select File → Import file, or drag-and-drop the openapi.json file into the browser window.
...
| Info |
|---|
Note: This method will allow you to view the documentation in Swagger UI, but you will only be able to interact with the API if it can be accessed from a public URL/IP address. In that case, replace http://localhost:5000/ in the url field with the correct address. Otherwise, you will need to install locally (see below) on the system that is running the Django backend in order to issue API calls through Swagger UI. Starting with Open API version 3.1.0, a new Swagger Editor was release (this is the linked version above) Legacy Open API Swagger Editor which supports versions 3.0.X can be accessed by visiting https://editor.swagger.io/ |
Installing Swagger Editor locally
...
| Expand |
|---|
| title | Account management (accounts) |
|---|
|
-
/accounts/api-token-auth/ Generate API token to authorize session -
/accounts/changePassword/ Change the password of the specified user /accounts/check_user/ Return username of logged in user
|
| Expand |
|---|
| title | General high-level API calls (api) |
|---|
|
-
/api/folder/{folderId}/tree/ Return a tree containing all children of the specified folder -
/api/request/{requestId}/ Return the contents of the specified request -
/api/status/ Report the status of the API backend, including mode -
/api/tree/ Return the highest level tree for this install -
/api/{entity}/allconfig/ Return a full listing of an entity type (nodes, apps, objects) -
/api/{entity}/allconfigfromtypes/ Return a full listing of an entity type (nodes, apps, objects) -
/api/{schemaId}/schema/ Return the schema file for the specified schema ID -
/api/itemTypes Return list of schema item types -
/api/schema/ Return the schema files for the specified schema IDs -
/api/{category}/{itemId}/move/ Move node or folder to new location -
/api/folder/add/ Add new folder -
/api/folder/{folderId}/view/ Get folder properties -
/api/folder/{folderId}/delete/Delete folder -
/api/folder/{folderId}/config/ Get folder configurations -
/api/folder/{folderId}/config/Adjust the settings of the specified node
|
...