Comments (7)
Hi @andrewbredow Have you taken a look at the api-designer, it displays the console side-by-side with a RAML editor you can use to develop you RAML file. It always uses the latest version of the api-console.
from api-console.
If the PR gets accepted, you could run grunt:
grunt server --ramlFileUrl http://localhost:9000/api.raml
from api-console.
Interesting! I have that running locally and I think it's pretty nice. We have a slight preference for not requiring developers to use a particular editor because:
- Our API documentation lives alongside our actual API code so it can be versioned alongside the implementation. As such, it's a challenge to have to symlink it to a web-accessible location
- We have our API docs split into many files to allow easier merges with multiple collaborators, and also to keep things clean.
In my opinion, this option is valuable in both the API Console and the Designer, for both development and "deploying" documentation for API consumers to use.
from api-console.
Designer has a file system API that you can overload so that you can show any files in it, from any source.
By default it stores files in localStorage. But if you implement a service that exports the same API as the one in https://github.com/mulesoft/api-designer/blob/master/app/scripts/services/mock-file-system.js you can pretty much show any files you want in the editor.
If you are going to do any file-system work, make sure that you use the file system API in branch https://github.com/mulesoft/api-designer/blob/epics/folder-support-917228/app/scripts/services/local-storage-file-system.js as it has changes needed for folder support.
from api-console.
I like @andrewbredow's idea because we have exactly the same "problem". We keep our API specification together with the source code and we have it in separated parts. I think it's a nice feature for the API console!
from api-console.
+1 for @andrewbredow's idea.
We also put our RAML definition of the API alongside the source code to keep docs and code in sync. Our team members code in different editors so while the API designer is pretty cool, people tend to prefer to code in their editors with all their plugins etc, instead of doing it in the browser.
Our dev workflow right now is to run the API console on a dev server and use the raml query string param so we open a URL such as http://api_console_dev_host:9000?raml=raml_file_dev_project:3456/api.raml and refresh this URL while doing changes in the raml file to see the results. This would be easier to do if we had a console option to predefine the raml file location. It'd be also easier to deploy a customer facing console without a query string raml param which might scare non-that-technical people away.
from api-console.
API Console version 3 is no longer supported. We are at version 6 right now.
Please, upgrade your version of the console to have latest updates.
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.