Basic Open API implementation#137
Open
Cobolt77 wants to merge 2 commits into
Open
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.
@rknell Created a PR instead of an issue to demonstrate the proof of concept.
The idea would be to make Alfred compatible with OpenAPI to use with softwares like Insomnia and Postman aswell as providing clean documentation for external developers to one's project.
Before going too far and doing a complete (and clean!) implementation of this, I wanted your take on this.
The way I see this, it would add an optionnal route parameter called "openAPIDoc" in which you could specify more details about the route. By default, it would at least render the path and path parameter.
Looking at my example, a simple route could be instantiated to open the OpenAPI document to the public.
As I mentionned, it's only a PoC before doing an actual implementation of this.
Is this something you would want in Alfred?
Thanks!
As a side note, below is a screenshot of the outputed file (left) and used with swagger (right)
