-
Notifications
You must be signed in to change notification settings - Fork 495
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add OpenAPI 3.0.x compatibility documentation. #1498
base: master
Are you sure you want to change the base?
Conversation
Make the middlewares documentation aware Add optional getters to the middleware to document better your code. Keep 100% compatibility with Swagger 2.0 documentation.
…es with type safe middlewares.
Improve support of arrays in OpenAPI routes.
…th <=4.2 Swift version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! This is a great piece of work.
The only comment I have is that it would be good to have test coverage for the new generator. But we could raise an issue for that, and it might make a good first issue for someone looking to contribute.
I will write the tests now. I think it makes sense to have both in-place, as it is too easy to break something. By the way, in the PR, I've fixed the usage of array in Swagger 2.0 that was broken with some getter with middlewares. It will be big to cover everything, but I will try to setup the groundwork for it. |
Set the NIO version to the newest 2.4.0.
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: