Generating documentation from RAML spec


#1

Is there an established way to generate documentation based on a RAML spec?

I would like something like the right hand side of the API Designer, but without the editor - that would be something like Swagger.

Thanks!


#2

There sure is! The API Designer is actually embedding the API Console on the right hand side, but they are maintained as independent code-bases/applications. You can grab the source for the API Console here: https://github.com/mulesoft/api-console

A visual refresh and interaction clean-up for this tool is also coming soon!

//Dillon


#3

Sweet, thank you!


#4

So are there any plans to having the tool generating a set of documentation for saving?
I want to easily be able to pass the documentation along without requiring anyone to run a server of any kind.

Do you have any more concrete examples of how to use this to generate the documentation?


#5

Community is working a lot in tooling.
I posted and published a nice (still basic, but promising) tool if you want to generate HTML.

Please, check this out: http://blog.raml.org/new-community-projects/


#6

Hi, thanks for your response (again) :smile:

I’ve actually made two contributions to raml2html already. Latest being here: https://github.com/kevinrenskers/raml2html/pull/3

I hope he will really consider this since he currently does not show uriParameters correctly. Obviously that project is still under development.

For anyone else interested, I created http://raml.herokuapp.com/ for people to try their raml files in the meantime. I wish the Load from URL works, but it doesn’t seem to.


#7

Hi @tsa ,
raml.herokuapp.com looks like a good idea.
But I’m not sure that’s working properly. I pasted a RAML file and obtained a huge JSON.

Is that expected?


#8

No, that’s not expected. I think the app is a bit wonky because the DOM’s not completely loaded. Should be fixed by the developers.

i.e. if you want the page to work correctly, you need to make sure the page finishes loading before you put the RAML in there.


#9

Hello, we are working on documentation generator from raml. Project site http://raml2html.leanlabs.io/

Project documentation: http://raml2html.leanlabs.io/documentation


#10

I can find one more generator here generating RESTful API documentations written in RAML : -


It supports 1.0 version.
Hope this will help