Comments (5)
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.
Related Issues (20)
- Uncaught DOMException: Failed to execute 'define' on 'CustomElementRegistry': the name "oauth2-authorization" has already been used with this registry HOT 1
- Angular10/webpack: Uncaught SyntaxError: redeclaration of formal parameter module HOT 2
- Uncaught DOMException: Failed to execute 'define' on 'CustomElementRegistry' on 6.1.1
- build process fails because of outdated dependencies
- AMF configuration issues HOT 1
- OAuth request elements are duplicated in the API console and API request panel HOT 2
- api-console with react HOT 3
- Hide children endpoints under collapsible top-level endpoints
- [email protected] fails to build standalone app
- API console doesn't render headers from a trait when creating a new endpoint method in RAML extension fragment HOT 1
- URI Parameter is not reflecting properly for endpoints
- Duplicated description, example and header on Types-page
- how to save changes HOT 1
- Build result in web components being registered multiple times
- Documentation not reachable
- api-console giving blank white screen for version 6.6.5 and works only for 6.1.1
- Can not access to document HOT 1
- api-console-a6952 not found or deleted?
- enable https to serve api-console on browser HOT 1
- OAS 3.0 not supported HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api-console.