Add make docs to render OpenAPI contracts as Swagger#601
Merged
Conversation
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
2 participants
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.
Add
make docsto view the contracts as SwaggerCloses the issue about viewing the OpenAPI contracts as Swagger. #599
Why
The contract sits in
contracts/as several files tied together by references. There was no quick way to see it as a Swagger page while working on it. Reading raw YAML is slow, and the backend/docsshows what the code serves, not what the contract files say.What this adds
A
make docscommand. It serves the contract as a Swagger page at http://localhost:8088 and opens it in the browser.It uses
swagger-ui-watcher, run through npx so there is nothing to install. The tool resolves the references across the path and schema files into one spec and reloads when any of them change, so you edit a file and the page updates.Port 8088 is used so it does not clash with the backend on 8000.
How to use
Then open http://localhost:8088 if it does not open on its own.
Fixes issue: #599