feat: add buf plugin to generate openapiv2 spec #2843
Merged
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.
I was unable to use the plugin opt
openapi_configuration
to supply the additional API configuration file (it simply doesn't find the file), but it's a matter of API users replacing the first 4 lines ofv2.swagger.yaml
with something like this:This enables interacting with v2 API using Insomnia built-in Swagger-UI or even using the web-hosted Swagger Editor.
By the way, there's not much control of file name, the plugin will always append ".swagger.yaml".
It's just a matter of running
buf generate
after changes on v2 API and commitingv2.swagger.yaml
to keep the spec updated.