inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-28 11:36:44 +00:00
Code

Update docs (#9564)

Browse Source 
- Mention browseable API
This commit is contained in:
Oliver 2025-04-22 22:18:59 +10:00 committed by GitHub
parent c6907a0bf2
commit 021063df72
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/api/index.md
View File

@ -17,17 +17,23 @@ The API is self-documenting, and the documentation is provided alongside any Inv
{% include 'img.html' %} {% include 'img.html' %}
{% endwith %} {% endwith %}
### Browseble API
If [debug mode](../start/index.md#debug-mode) is enabled, the API can be browsed directly from the web interface. This provides a simple way to explore the API and test out different endpoints. Simply navigate your web browser to any API endpoint, and the API will be displayed in a human-readable format.
### Schema Description ### Schema Description
The API schema is also documented in the [API Schema](./schema.md) page. The API schema is also documented in the [API Schema](./schema.md) page.
### Generating Schema File ### Generating Schema File
If you want to generate the API schema file yourself (for example to use with an external client, use the `invoke dev.schema` command. Run with the `-help` command to see available options. If you want to generate the API schema file yourself. For example, to use with an external client, use the `invoke dev.schema` command. Run with the `-help` command to see available options.
``` ```
invoke dev.schema -help invoke dev.schema -help
``` ```
## Authentication ## Authentication
Users must be authenticated to gain access to the InvenTree API. The API accepts either basic username:password authentication, or token authentication. Token authentication is recommended as it provides much faster API access. Users must be authenticated to gain access to the InvenTree API. The API accepts either basic username:password authentication, or token authentication. Token authentication is recommended as it provides much faster API access.