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

Generate Documentation from bruno collections #49

Open
helloanoop opened this issue Oct 26, 2022 · 5 comments
Open

Generate Documentation from bruno collections #49

helloanoop opened this issue Oct 26, 2022 · 5 comments

Comments

@helloanoop
Copy link
Contributor

helloanoop commented Oct 26, 2022

Develop functionality to generate api documentation for a collection.
This should be available to be executed in the app (generate a zip file with assets) as well as as a cli command that can be run on the local collections on the filesystem.

Requested by Jannis - https://dev.to/jannisdev/comment/22eh8

@reilg
Copy link

reilg commented Oct 28, 2022

Is it possible to export a collection as an OpenAPI spec instead?

@helloanoop
Copy link
Contributor Author

Yes, this should be possible.

@reilg May I know your use case ?
I mean I'd like to know the benefits of converting it to OpenAPI spec ?

@luccasr73
Copy link

luccasr73 commented Oct 14, 2023

@helloanoop this can be used in tools like https://orval.dev/

@sohaha
Copy link

sohaha commented Feb 15, 2024

Is there a plan for support?

@benedictjohannes
Copy link

@helloanoop Conversion to OpenAPI spec is very interesting because tooling around openAPI spec is quite complete. If Bruno can export to openAPI, then existing openAPI tooling can be used to generate documentation.

If you have either documentation generation or openAPI export on the roadmap, I'll be purchasing Golden Edition to support you.

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

No branches or pull requests

5 participants