Comments (7)
This would be nice. So after a code push Jenkins can generate or update the API documentation.
+1
from api-console.
@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à.
from api-console.
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! :)
from api-console.
Thanks @Philzen: the raml2html thing is a good first step!
from api-console.
It's still unclear that this is possible in the documentation. We can't run the required stack on our production envrionment.
from api-console.
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.
from api-console.
Fixed with c74eacd
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.