servala-portal/docs/modules/ROOT/pages/api.adoc
Tobias Brunner d61465b6ea
All checks were successful
Build and Deploy Antora Docs / build (push) Successful in 38s
Build and Deploy Antora Docs / deploy (push) Successful in 5s
move over documentation from old place
2025-03-11 15:37:13 +01:00

7 lines
No EOL
547 B
Text

= Portal API
To allow the use of infrastructure as code tools like Terraform, Pulumi or even Crossplane, the portal exposes an API.
The API is following the RESTful API principle and makes use of the OpenAPI v3 standard.
We will either use https://django-ninja.dev/[Django Ninja^] or https://www.django-rest-framework.org/[Django REST framework^] to build the API.
Throughout the development, it's crucial to differentiate between views and business logic, so that we can reuse the same business logic for the web portal, as well as for the API.