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

# API documentation

We also want to generate documentation of the (generated) API to make it more useful in real life.

## Purpose

To take an API in production, it needs to be documented. For this purpose we want to generate Swagger files.

![Generating a Swagger file](https://3502282321-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-L9s__kkYiQvvyW5CKOk%2F-M3UYTetEJEh1GLcTO4P%2F-M3X1IZTYhRlpWmYg1mR%2FUntitled%20Diagram%20\(8\).png?alt=media\&token=7962876f-3f23-4806-964e-df9b3d1d6d24)