About
REST API documentation: an OpenAPI 3.1 document generated from the product's routes and what their views declare, read in a Swagger UI at /apidocs
Provides
Routes
/apidocs//apispec_1.json
Hooks filled
apikeys.sidebar.developer
Translations
es
Configuration
| Setting | Default | What it does |
|---|---|---|
APIDOCS_TITLE |
{SITE_NAME} REST API
|
Title of the documentation page and of the spec. {SITE_NAME} becomes the product's site name when the docs are served; without one the title is "REST API". |
APIDOCS_DESCRIPTION |
empty | What the API is for, shown under the title. Empty shows nothing. |
APIDOCS_VERSION |
1.0.0
|
Version of the API the docs describe, as the spec's info.version. |
APIDOCS_PATHS |
/api/
|
The paths that are the API. Every rule under one of them is documented, from its route alone when its view declares nothing; a rule elsewhere only when its view declares a spec. |
These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.
Dependencies
Works better with
In product lines
- openhubs_spl Optional in this line
Extension points
Templates
apidocs/index.htmlhooks/sidebar_apidocs.html
Routes
A refinement can add routes to its blueprint
Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.
Compatibility
Python
>=3.13
SPLENT framework
>=1.30.0
Python packages
flasgger==0.9.7.2.dev2PyYAML>=6.0