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.

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

Add OpenAPI documentation #28

Open
4 tasks
balintking opened this issue Jun 13, 2024 · 0 comments
Open
4 tasks

Add OpenAPI documentation #28

balintking opened this issue Jun 13, 2024 · 0 comments
Labels
backend Backend development documentation Improvements or additions to documentation

Comments

@balintking
Copy link
Collaborator

Description

Integrate Swagger/OpenAPI documentation into the project to provide clear and interactive API documentation for developers.

Read docs: https://docs.nestjs.com/openapi/introduction

Tasks

  • Install Swagger dependencies in the project.
  • Configure Swagger for the Next.js project.
  • Ensure the documentation is accessible via a specific route.
  • Document the OpenAPI access route in the README file.

Acceptance Criteria

  • Swagger/OpenAPI documentation should be available and accessible.
  • All existing API endpoints should be documented clearly.
@balintking balintking added documentation Improvements or additions to documentation backend Backend development labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Backend development documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant