Enable/disable openAPI on a per-route basis
Open
Nobody has claimed this yet.
enhancement
v2
- Dominant language
- TypeScript
- Stars
- 11.2k
- Forks
- 899
- Avg merge
- 2d 24m
- Merged PRs (30d)
- 40
Description
Describe the feature
It would be great to only enable openAPI for specific routes.
In my usecase only parts of my backend is public, but I would like to use the experimental openAPI feature for them.
Additional information
- Would you be willing to help implement this feature?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating Nitro's experimental OpenAPI implementation and the route registration or configuration entry points. Determine how route-level enablement should be expressed and how public routes should be distinguished from the rest of the backend. Done means OpenAPI is exposed only for explicitly enabled routes while existing behavior remains unchanged elsewhere.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100