Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API Documentation #17

Open
pellecchialuigi opened this issue Feb 12, 2024 · 1 comment
Open

API Documentation #17

pellecchialuigi opened this issue Feb 12, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@pellecchialuigi
Copy link
Collaborator

Start a documentation section to describe how to use the API project.
Describe supported verbs and required argument with expected argument type for each endpoint.
@pellecchialuigi pellecchialuigi added the documentation Improvements or additions to documentation label Apr 12, 2024
@pellecchialuigi
Copy link
Collaborator Author

That can be done using OpenAPI.
The OpenAPI code in comment is in general a lot of text, so probably an approach can be to move the logic of each endpoint in separate files, one for table/endpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pellecchialuigi