It's an interesting product as a tool for documentation, but where it gets really useful is that next step (presumably to come) where the structured content is not only used to mock a server, but to actually implement the server.
I would love to do a one-click deploy to express/everyauth (for node) or app simple sinatra/warden app for the ruby folks.
Once you define the auth requirements and the API itself, there's little left beyond the boilerplate.
I imagine a simple, closed-loop solution with semantic versioning that consumes the blueprint like a config file. As we update the blueprint and bump versions, the appropriate changes would be reflected on the server. Your live environment would be naturally in sync with documentation, and it would be versioned and tested.
Such a solution entirely frees us up to focus on the app itself, which would be very cool.
We do have some prototypes, but we are yet to venture beyond scaffolding..and honestly, we are more focused to provide basic, universal tooling and let respective communities to handle their-favorite-language/framework bindings.
From what I tried, it is fairly easy to get "almost there", but the remaining 10% is dealbreaker. If too much editing constraints are placed on resulting application, it feels odd and it's easy to break them and thus diverge from original blueprint.
One possible approach is to maintain original blueprint, then say "Let us implement" and completely blueprint as "primary data source" into scaffolded application -- into module/method docstrings and start generating blueprint back from there.
However, we are yet to find something that feels unobstrusive and natural during whole development cycle. Suggestions certainly welcome.
Right on. In our particular case, we have an API that's fairly well built-out, so I would probably toy around with this on the next side project.
Rather than having a 100% there solution that's opaque, I think the cool thing would be to have an open source project that handles the boilerplate.
Then, you could fork, point to your blueprint, and deploy in minutes and then do whatever tweaking is required to cover the remaining 10% (there's always something).
Keep up the great work--I am definitely interested (and will check out swagger, as well!).
I would love to do a one-click deploy to express/everyauth (for node) or app simple sinatra/warden app for the ruby folks.
Once you define the auth requirements and the API itself, there's little left beyond the boilerplate.
I imagine a simple, closed-loop solution with semantic versioning that consumes the blueprint like a config file. As we update the blueprint and bump versions, the appropriate changes would be reflected on the server. Your live environment would be naturally in sync with documentation, and it would be versioned and tested.
Such a solution entirely frees us up to focus on the app itself, which would be very cool.