8x8Cloud / swagger2raml

A utility to generate RAML documentation from Swagger JSON
Other
84 stars 8 forks source link

raml2swagger #3

Open phonyphonecall opened 10 years ago

phonyphonecall commented 10 years ago

Feature Request

Allow swagger2raml to intake raml, and emit swagger json.

Hear me out:

The raml project is meant to allow enable users to design their API before any implementation is started. swagger2raml is obviously a useful tool in introducing users to the new raml language. By allowing users to convert their raml to swagger, we can enable rapid adoption in the community.

For example, my employer (insert large tech corporation here), currently uses swagger document all services. And although they are going to slowly move to raml, the swagger standard will not go away for quite sometime. If my team wants to start using raml, they will still need to leave all of the swagger annotations in the resource class, and the swagger generation logic in the build, as well as add additional tooling to start using raml effectively.

If we had a raml2swagger tool, we could simply add in our raml tooling, then generate our swagger json from that raml at build time. This way we can start forgetting about swagger immediately but still provide the swagger spec to those teams that wish to look at it.

I actually believe this fits within the scope of this project, simply because so much logic can be reused.