feat: add dynamic OpenAPI/Swagger documentation#1761
Open
monil80 wants to merge 1 commit into
Open
Conversation
|
This looks like a useful change. One thing I would suggest is adding regression tests for both the new behavior and the existing behavior, so the change does not accidentally break current filtering syntax. For example, if the PR changes filtering behavior, it would be useful to test: GET /posts?title=helloand also any equivalent That would make the change safer and easier to review because maintainers can see exactly which behavior is intended to change and which behavior should stay compatible. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GET /docs— Swagger UI (CDN, no new dependencies)GET /openapi.json— OpenAPI 3.0 generated fromdb.jsonat runtime--no-swaggerandcreateApp({ swagger: false })to disableTest plan
npm testnpm run lintnpx json-server fixtures/db.json→ http://localhost:3000/docsnpx json-server --no-swagger fixtures/db.json→/docsreturns 404