mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-04-28 21:56:49 +00:00
48baf7e051
* Move API documentation into separate directory * Rearrange main docs bar * Split python examples into separate page * Fix broken links * Adds page for browseable API * Fix image links * Add entrypoint page for barcodes * Update barcode docs * Add (empty) pages for internal and external barcods * Add documentation on "internal" barcode format * Documentation for external barcode functionality * Skeleton page for custom barcode information * Extend docs for custom barcodesplugins * Add stubs for new API docs * Add documentation for downloading data via the AP * API metadata information * docs for pythonic metadata access * docs for bulk delete
38 lines
1013 B
Markdown
38 lines
1013 B
Markdown
---
|
|
title: Interactive API
|
|
---
|
|
|
|
## Interactive API
|
|
|
|
If the server is running in [Debug Mode](../start/intro.md#debug-mode) then an interactive version of the API is available using a browser.
|
|
|
|
!!! info "Debug Mode"
|
|
This interactive API is only available when running the server in debug mode
|
|
|
|
!!! warning "Slow Traffic Ahead"
|
|
The interactive API is *significantly* slower than using the normal JSON format. It is provided only for development and testing.
|
|
|
|
### List View
|
|
|
|
Various list endpoints can be displayed as shown below:
|
|
|
|
{% with id="api_browse", url="api/api_browse.png", description="List API" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
### Filtering
|
|
|
|
List views can be filtered interactively:
|
|
|
|
{% with id="api_filter", url="api/api_filters.png", description="Filter API" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
### Detail View
|
|
|
|
Detail view endpoints can also be displayed:
|
|
|
|
{% with id="api_detail", url="api/api_detail.png", description="Detail API" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|