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

Support for Swagger documenation format #29

Closed
arojunior opened this issue Mar 19, 2018 · 5 comments
Closed

Support for Swagger documenation format #29

arojunior opened this issue Mar 19, 2018 · 5 comments

Comments

@arojunior
Copy link
Contributor

API Doc Parser is designed to parse any API documentation format and convert it in the same intermediate representation. For now, only Hydra is supported but if you develop a parser for another format, please open a Pull Request to include it in the library.

I want to work in a parser for swagger documentation to be compatible with client-generator

There is some documentation about the layout of this "intermediate representation"? How it should be?

@dunglas
Copy link
Member

dunglas commented Mar 19, 2018

Great that you'll work on that!
Basically, you need to create a new factory function for Swagger that will hydrate the same output as parseHydraDocumentation (https://github.com/api-platform/api-doc-parser/blob/master/src/hydra/parseHydraDocumentation.js).

@mysiar
Copy link
Member

mysiar commented Mar 22, 2018

Hi @arojunior looking forward to it. I was thinking to do it myself but day is to short ;)

@arojunior
Copy link
Contributor Author

Hi guys, just to give you a feedback... I think I'm almost there.

@mysiar my day is too short as well, that's why I'm taking so long.

I'm working on it here: https://github.com/arojunior/api-doc-parser/tree/swagger-parser

@mysiar
Copy link
Member

mysiar commented Jun 8, 2018

@arojunior can we close this issue now?

@arojunior
Copy link
Contributor Author

Sure!

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

3 participants