feat: add openapi and swagger ui docs for the JSON API#245
Open
runleveldev wants to merge 2 commits intomainfrom
Open
feat: add openapi and swagger ui docs for the JSON API#245runleveldev wants to merge 2 commits intomainfrom
runleveldev wants to merge 2 commits intomainfrom
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
1 participant
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.
This pull request adds Swagger UI API documentation support to the project by introducing new dependencies and updating the server setup. The changes primarily focus on making API docs available at the
/apiendpoint using an OpenAPI YAML specification.API Documentation Integration:
swagger-ui-expressandyamljsas dependencies in bothpackage.jsonandpackage-lock.jsonto enable serving and parsing OpenAPI specs. [1] [2]server.jsto require and configureswagger-ui-expressandyamljs, loading the OpenAPI spec fromopenapi.yamland mounting the Swagger UI at the/apiroute. [1] [2]Dependency Updates:
package-lock.jsonto support Swagger UI and YAML parsing, including@scarf/scarf,argparse,fs.realpath,inflight,path-is-absolute,sprintf-js,swagger-ui-dist, and others. [1] [2] [3] [4] [5] [6] [7] [8]These changes make it much easier for developers and users to explore and understand the API endpoints via interactive documentation.