> For the complete documentation index, see [llms.txt](https://admincode.gitbook.io/admincode/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://admincode.gitbook.io/admincode/basics/apis-and-integrations.md).

# APIs and Integrations

## [OpenAPI](https://swagger.io/specification/) &#x20;

/swagger-ui/index.html

The integration of OpenAPI with the application enables automatic generation and documentation of the RESTful APIs within the system. By using tools like Springdoc OpenAPI, the API definitions are created based on the annotations in the code, making it easier to document and expose the available endpoints.&#x20;

The OpenAPI specification provides a structured format for describing the endpoints, request/response formats, authentication mechanisms, and other important metadata, which can be used by consumers and developers to interact with the API effectively. This integration not only streamlines the process of documenting the API but also ensures consistency, reduces errors, and allows for easier testing and maintenance of the API.&#x20;

<figure><img src="https://2308997185-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8FIBMz5maCg8JQVrVt15%2Fuploads%2FDQOUPQDrkysuNdUsiaho%2FScreenshot%202025-02-08%20at%202.22.14%E2%80%AFPM.png?alt=media&amp;token=2baae9b1-aef7-423b-88ad-9241c39388ea" alt=""><figcaption></figcaption></figure>
