Skip to content
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

Basic Open API implementation #137

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Cobolt77
Copy link

@Cobolt77 Cobolt77 commented Jan 16, 2025

@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)
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant