servala/servala-portal
3
0
Fork 0
Code Issues 21 Pull requests 5 Projects 2 Releases Packages 2 Activity Actions

move over documentation from old place
All checks were successful
Build and Deploy Antora Docs / build (push) Successful in 38s
Details
Build and Deploy Antora Docs / deploy (push) Successful in 5s
Details

Browse source
This commit is contained in:
Tobias Brunner 2025-03-11 15:37:13 +01:00
parent 16e8c2729b
commit d61465b6ea
No known key found for this signature in database
11 changed files with 1184 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/modules/ROOT/pages/api.adoc Normal file
View file

@ -0,0 +1,7 @@
= 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.