search

mulesoft / api-console

An interactive REST console based on RAML/OAS files
Other
911 stars 238 forks source link

CLI & static documentation generation #30

Closed oleksandr closed 7 years ago

oleksandr commented 10 years ago

More like an enhancement - not everyone in this world is using node.js or is willing/allowed to have all its related mumble-jumble installed on the infrastructure servers.

What would be really nice is to have a CLI command to generate static documentation (similar to https://readthedocs.org, as example). The feature of "Try it" can also be included and rely on a proxy, which settings would be provided before generation.

I'm willing to contribute, but not with the current stack used for implementation :-(

MMore commented 10 years ago

This would be nice. So after a code push Jenkins can generate or update the API documentation.

+1

dmartinezg commented 10 years ago

@oleksandr, @MMore , you don't need to use node.js at all you can deploy the dist/ directory anywhere you want, update the index.html file to point to your RAML file (which can be deployed with the console or anywhere as long as there is a public URL) and voilà.

Philzen commented 10 years ago

@dmartinezg :+1:

Could we maybe state that clearer in the readme? I was basically done setting up an external server for this - only when it occured to me after seeing your comment that the "ugly" part (lower 2/3rd) is basically only need for local testing / building / development, correct?

@oleksandr have you tried raml2html? It's basically exactly the approach you are looking for - although not as full blown as readthedocs yet, but we'll see ;)

Which brings me to my most pressing question right now: Is there any way to include / show only the "try-it" section - that is the only piece left in that puzzle, as API console is the killer app for that! :)

MMore commented 10 years ago

Thanks @Philzen: the raml2html thing is a good first step!

Relequestual commented 7 years ago

It's still unclear that this is possible in the documentation. We can't run the required stack on our production envrionment.

sichvoge commented 7 years ago

CLI will be provided by the new console version (see info here) and you only have to deploy the generated version on a simple HTTP server.

jarrodek commented 7 years ago

Fixed with https://github.com/mulesoft/api-console/commit/c74eacde58e40d1d79c4885b15fa3ff210b6610c