api-designer
api-designer copied to clipboard
Support for browsing directories
I have successfully hooked up my own filesystem running the api-designer locally. But I noticed the directories don't show up in the sidebar. I have looked into the code, and despite it seems like the folder files of the current directory are parsed and saved, they are not used anywhere. Is this something that is being worked on? I'm trying to add it myself otherwise.
Some guidance will be welcomed, thanks!
Hey @polmiro
Right now directories are not fully supported, though filesystem interface is there, nothing is being displayed yet. We're working on it and there is dedicated branch (https://github.com/mulesoft/api-designer/tree/epics/folder-support-917228) for it that you can track (yes, it hasn't been updated for a while, but we'll get back to it soon).
If you like AngularJS and have fun writing a code, you could try to accomplish it by yourself :) Don't forget to send PR and we'll be happy to review!
@xaka thanks for pointing me out that branch. The branch is a bit diverged, so it might be easier to start from scratch and cherry pick some of the things. Hopefully will be able to get a PR soon.
@polmiro what is your status on that? are you still working on that?
Would be nice to see something happen with this. I don't know how to version control my files without having them on the filesystem...
Perhaps this project could be used as a base https://github.com/colthreepv/express-raml-store. Works fine for me.
Not having this feature is a no go for me to adopt Api Designer, because I want to be able to version control all Raml files inside my project.
Any one found a good solution for this?
I have something yes. It's actually not to difficult. Let me try to consolidate something this week and publish it as documentation into that repo.
@sichvoge can you point me towards the solution you mentioned?
Hi. Sorry for the late response. As this project is basically meant to be something embeddable and flexible to what filesystem will be used; I decided to create a version with the ability to use your local filesystem in my personal repo.
It's really only using this API designer with some tweaks I have explained inside the README file.
We are currently working on a new version of the API designer which we will distribute also as an Elektron app. That would mean you will be able to use your local filesystem OOTB. For the time we are working on this, you are free to use my version or create your own based on the provided code on my repo.
https://github.com/sichvoge/api-designer-fs
@sichvoge is the Electron App already available to use?
The lack of a way to integrate a proper Raml editor that can edit the raml files directly from the git repos in the file system of our PC's is the major blocker to adopt Raml for Api Design First approach :(