Skip to content

Commit 021063d

Browse files
Update docs (inventree#9564)
- Mention browseable API
1 parent c6907a0 commit 021063d

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/docs/api/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,23 @@ The API is self-documenting, and the documentation is provided alongside any Inv
1717
{% include 'img.html' %}
1818
{% endwith %}
1919

20+
### Browseble API
21+
22+
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.
23+
2024
### Schema Description
21-
The API schema is also documented in the [API Schema](./schema.md) page.
25+
26+
The API schema is also documented in the [API Schema](./schema.md) page.
2227

2328
### Generating Schema File
2429

25-
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.
30+
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.
2631

2732
```
2833
invoke dev.schema -help
2934
```
3035

36+
3137
## Authentication
3238

3339
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.

0 commit comments

Comments
 (0)