From 021063df7287adb6950c2477683d05c2d6204fc4 Mon Sep 17 00:00:00 2001 From: Oliver Date: Tue, 22 Apr 2025 22:18:59 +1000 Subject: [PATCH] Update docs (#9564) - Mention browseable API --- docs/docs/api/index.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/docs/api/index.md b/docs/docs/api/index.md index 07dc6cdab0..aa6f93223e 100644 --- a/docs/docs/api/index.md +++ b/docs/docs/api/index.md @@ -17,17 +17,23 @@ The API is self-documenting, and the documentation is provided alongside any Inv {% include 'img.html' %} {% 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 - 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 -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 ``` + ## 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.