Any interest in the ability to pass in a RAML path when the server is started? about api-console HOT 7 CLOSED

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:

1. 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
2. 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.