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

Update API documentation / make it auto-generated and interactive #134

Open
franzwollang opened this issue Mar 12, 2023 · 1 comment
Open

Update API documentation / make it auto-generated and interactive #134

franzwollang opened this issue Mar 12, 2023 · 1 comment
Assignees
@TheDoplarEffect
Labels
documentation Improvements or additions to documentation technical debt

Comments

@franzwollang
Copy link

There is some API documentation in the 'README.md' file, however it is incomplete and likely out of date.

The standard practice would be to generate interactive API documentation by creating an OpenAPI schema and using a GUI like Swagger UI. There are libraries that help provide these for Next.js projects. Please consider looking into them and using one.
@franzwollang franzwollang added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 12, 2023
@franzwollang franzwollang changed the title Incomplete API documentation Update API documentation / Make it auto-generated and interactive Mar 12, 2023
@franzwollang franzwollang changed the title Update API documentation / Make it auto-generated and interactive Update API documentation / make it auto-generated and interactive Mar 12, 2023
@franzwollang franzwollang added technical debt and removed enhancement New feature or request labels Mar 12, 2023
@suzypowers suzypowers removed their assignment Mar 13, 2023
@amyria3
Copy link
Collaborator

amyria3 commented Mar 16, 2023

https://github.com/devhausleipzig/camp8-final-project/tree/read_me

@amyria3 amyria3 linked a pull request Mar 16, 2023 that will close this issue
SwaggerUI implementation for endpoints #158
Closed
@TheDoplarEffect TheDoplarEffect self-assigned this Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TheDoplarEffect TheDoplarEffect

Labels
documentation Improvements or additions to documentation technical debt
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

SwaggerUI implementation for endpoints devhausleipzigacademy/camp8-final-project
4 participants
@franzwollang @TheDoplarEffect @amyria3 @suzypowers