kir-dev / kir-dev/collage-schedule-planner

Add OpenAPI documentation

Open
#28 0 comments 0 reactions 0 assignees View on GitHub
backend documentation
Dominant language
TypeScript
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

### 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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Read the linked NestJS OpenAPI guide, then inspect the project's existing API endpoints and README to determine the integration points and documentation route. Done means Swagger/OpenAPI is accessible at a documented route, all existing endpoints are documented, and the README explains how to access it.

Written by the indexing model from the issue text.

Assessment

Tech stack
next.js, openapi, typescript
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.