search

c0c0n3 / kitt4sme.live

On a mission to bring AI to the shop floor: https://kitt4sme.eu/
MIT License
1 stars 28 forks source link

[Datasheets] API documentation #391

Closed kostasgrevenitis closed 11 months ago

kostasgrevenitis commented 11 months ago

The Datasheets API documentation has to be improved

vcutrona commented 11 months ago

What about using OpenAPI as a standard for API documentation? The Datasheets backend is implemented in Python using Flask (I checked this repo: https://github.com/Advanced-Dataspaces-VTT/KITT4SME-Digital-Datasheets/tree/main/backend) You can either consider to generate the OpenAPI spec by exploiting python libs like flask-rest-api or flask-restful-swagger-3, or migrating the app to FastAPI, which automatically provides the OpenAPI spec we need (checkout for example PC API spec

With the OpenAPI spec we can speed up further integrations with the Datasheets backend (e.g., by automatically generating clients with openapi generator

karikolehmainen commented 11 months ago

OpenAPI documentation is added for backend REST API. Does not work with cluster as OpenAPI don't seem to like path based routing and we are migrating to subdomain routing, so no point resolving that issue as it becomes obsolete