Sitelet https://web.archive.org/web/20210107020314/https://github.com/nelmio/NelmioApiDocBundle/issues/1613
Skip to content

/ NelmioApiDocBundle

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

Jump to bottom

How to generate API documentation in yaml swagger format? #1613

Open
supermiro opened this issue Apr 6, 2020 · 2 comments
Open

How to generate API documentation in yaml swagger format? #1613

supermiro opened this issue Apr 6, 2020 · 2 comments
Labels
enhancement good first issue

Comments

@supermiro
Copy link

@supermiro supermiro commented Apr 6, 2020

In Nelmio UI there is missing some yaml preview of generated API, is it possible to generate documentation in yaml format? Some tools for testing like soap ui are able to import yaml swagger file and then soap ui is able to work with this file and apis. Solution?
@GuilhemN
Copy link
Collaborator

@GuilhemN GuilhemN commented May 29, 2020

We provide a controller to export to JSON but not to Yaml for now: https://github.com/nelmio/NelmioApiDocBundle/blob/v3/Controller/DocumentationController.php.
We could probably update it to support Yaml as well based on a format parameter though.
If you would like to submit a PR it would be more than welcome :)
@hubertnnn
Copy link

@hubertnnn hubertnnn commented Oct 27, 2020 •
edited

If I remember correctly json is a subset of yaml, so if you need a yaml, then providing json should work fine.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@hubertnnn @GuilhemN @supermiro
You can’t perform that action at this time.