add API documentation file

burrito-project · Nov 13, 2024 · f879776 · f879776
1 parent 8fdb1ae
commit f879776
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/api_documentation.md b/docs/api_documentation.md
@@ -0,0 +1,13 @@
+# API documentation
+
+For the API documentation we followed a code-first approach. The documentation
+is generated from the source code using [`utoipa`](https://github.com/juhaku/utoipa),
+which generates an OpenAPI 3.1 specification file at compile time.
+
+This specification is then consumed and rendered by
+[Scalar](https://github.com/scalar/scalar). The final document result is served
+by the API itself, and can be publicly accessed at `/docs`.
+
+![API Documentation](./static/api_docs.png)
+
+Live documentation is hosted in <https://api.contigosanmarcos.com/docs>.
diff --git a/docs/static/api_docs.png b/docs/static/api_docs.png