Documentation
¶
Overview ¶
Command apicheck reports how much of the Audiobookshelf API the API document covers, and fails when a route is missing. The client in sdk/abs is generated from the document, an operation for each of its routes, so what the document covers the client does.
The public API docs say they are unmaintained, and the server's own OpenAPI file covers under a quarter of the routes and stopped in 2024. So the route table in the server source is the reference: this reads it, reads the routes of the document in api-defs, and lists every route the document lacks, as when the server gains one after the version the document was read from.
go run ./sdk/apicheck # against the server's master branch go run ./sdk/apicheck -list # also list every route not covered go run ./sdk/apicheck -ref v2.37.1 # against a release
Run it from the repository root, as make apicheck does.
Click to show internal directories.
Click to hide internal directories.