Start porting the backend REST API documentation to OpenAPI #6682
prettyirrelevant
started this conversation in
Ideas
Replies: 1 comment
-
So we had a discussion in person about the benefits of porting the documentation to OpenAPI (Swagger) and the benefits it provides.
We also had a look at trueblocks' API documentation, and they use redoc for the generation of the webpage. We need to check if there is a way to automatically generate the OpenAPI spec directly from the flask backend code. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Abstract
Currently, the API documentation is lacking in the proper structure of response specifically in a situation whereby the response is an array of objects or a nested object.
Motivation
Porting to a new solution will improve developer experience in understanding how the API works and proper description of fields being returned.
Specification
Beta Was this translation helpful? Give feedback.
All reactions