Pass in "Load from URL" value via the URL about api-console HOT 5 CLOSED

Just comment out the element on index.html, and point this element to your RAML:

<raml-console with-root-documentation src="http://api.yourdomain.org/apidocs/main.raml"></raml-console>

That approach has worked great for me on my public documentation.

from api-console.

Hi Andrew,

I was actually looking for a more dynamic version as I would like this page to be able to consume different RAML files. The console page itself is dynamic as one can fill in the form with any URL they want and the console will generate the entire API docs (and it can also dynamically take in pure RAML).

My end goal is to be able to separate the RAML files from the rendering of the documentation. For example:

• http://my.docserver.example.com/console?url=http://github.com/some/raml/file_v1.raml
• http://my.docserver.example.com/console?url=http://github.com/some/raml/file_v2.raml
• http://my.docserver.example.com/console?url=http://github.com/some/other/project/other_v1.raml

That way, I don't have to make any changes to the API Console server, but I am able to dynamically generate API docs for any RAML file I want to pass in. I think it's just a matter of taking in a GET argument and hooking it into the "Load From URL" form.

Thanks

from api-console.

Oh, I see. Yes, you want to use the raml query string parameter, then. For example:

http://my.docserver.example.com/console?raml=http://github.com/some/raml/file_v1.raml

from api-console.

@andrewbredow thanks for the comment, I was about to respond with the same thing! This should do exactly what you are looking for, @gtrevg

from api-console.

Worked like a charm. Thanks!

from api-console.