Add OpenAPI 3.0.x compatibility documentation. #1498
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.
Make the middlewares documentation aware
Add optional getters to the middleware to document better your code.
Keep 100% compatibility with Swagger 2.0 documentation.
Description
Generate an OpenAPI 3.0.x documentation using the Kitura-OpenAPI framework.
The new features are:
This PR requires Kitura-OpenAPI PR #29 (Kitura/Kitura-OpenAPI#29) for a correct display of OpenAPI specification. This is not affecting the Swagger 2.0 display.
Motivation and Context
The automatic documentation of routes could be improved.
The OpenAPI 2.0 (aka Swagger 2.0) is outdated and the 3.0 should be used instead.
How Has This Been Tested?
A side project to see the result is available in https://github.com/mbarnach/KituraOpenAPIExample
Checklist: