Application Programming Interface

General Information and Interactive Documentation

The web-based application programming interface (API) of the central LOC-DB component offers basic Create, Read, Update, Delete (CRUD)-Services intended for general management of the bibliographic resources, as well as more advanced service endpoints, e.g. for statistics on the current system state or for the retrieval of reference target suggestions from external sources. The API is described using Swagger's interactive API documentation [1] feature. Once the application is started, the documentation is accessible at /docs.

The documentation indicates for each endpoint the corresponding HTTP request method, the name, its purpose, the parameters (with types and description) and more. Moreover, it allows the user to directly try out the services to illustrate the usage in an interactive way. We recommend all programmers that intend to build an application on top of the LOC-DB central component, to take a look at this documentation.

[1] https://swagger.io/solutions/api-documentation/

Service Documentation

In the following, you can find a short description of each individual service automatically converted from the /docs endpoint.

This browser does not support PDFs. Please download the PDF to view it: Download PDF.