32 lines
803 B
Markdown
32 lines
803 B
Markdown
---
|
|
title: Interactive API
|
|
---
|
|
|
|
## Interactive API
|
|
|
|
If the server is running in [Debug Mode](../start/index.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:
|
|
|
|
{{ image("api/api_browse.png", "List API") }}
|
|
|
|
### Filtering
|
|
|
|
List views can be filtered interactively:
|
|
|
|
{{ image("api/api_filters.png", "Filter API") }}
|
|
|
|
### Detail View
|
|
|
|
Detail view endpoints can also be displayed:
|
|
|
|
{{ image("api/api_detail.png", "Detail API") }}
|