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

Setup Node API Service for OpenAPI 3.0 #4

Open
3 tasks
PandaCoffeeBara opened this issue Aug 14, 2024 · 0 comments
Open
3 tasks

Setup Node API Service for OpenAPI 3.0 #4

PandaCoffeeBara opened this issue Aug 14, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@PandaCoffeeBara
Copy link
Owner

PandaCoffeeBara commented Aug 14, 2024

As a developer, I want to set up the API service using the OpenAPI 3.0 standard so that the project maintains high-quality documentation and follows industry best practices.

The task involves setting up the API service, its folder structure and documentation.
The project will be set up to automatically generate documentation based on its public routes, a separate dev configuration that would also include private routes.

An integration with Swagger docs or Redoc for documentation will be set in place.

Acceptance Criteria:

  • OpenAPI 3.0 spec is created and includes documentation for the current API endpoints
  • API will serve the documentation at the specific route /api-docs
  • Folder and project doc to be updated with latest information
@PandaCoffeeBara PandaCoffeeBara self-assigned this Aug 14, 2024
@PandaCoffeeBara PandaCoffeeBara added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant