Swagger used for top down API design

[rw]

Is anyone aware of a solution to use Swagger as a top down API design approach much like RAML? 

[Kin Lane]

There are lots of folks using it in this way, just not the centralized tooling like RAML has.

Are you looking for the tooling to help you with entire API design lifecycle? or just thoughts on the process & flow?

Kin Lane (API Evangelist)

kin...@gmail.com

@kinlane

--

apievangelist.com

apicommons.org

apivoice.com

--

On Tue, May 13, 2014 at 7:28 AM, rw <rpwi...@gmail.com> wrote:

Is anyone aware of a solution to use Swagger as a top down API design approach much like RAML? 

--
You received this message because you are subscribed to the Google Groups "API Craft" group.
To unsubscribe from this group and stop receiving emails from it, send an email to api-craft+...@googlegroups.com.
Visit this group at http://groups.google.com/group/api-craft.
For more options, visit https://groups.google.com/d/optout.

[rw]

primarily would like to have a complete spec to hand off to developers. 

[rw]

In the API world how many do top down design vs bottom up.  We are currently stubbing out the api design in code and having the swagger doc generated for review prior to marching forward.  I would prefer to creating a Swagger design doc prior to touching code. Of course the next logical step would be auto generation of the stub code. 

On Tuesday, May 13, 2014 12:47:40 PM UTC-5, Kin Lane wrote:

[Kin Lane]

There is tooling to generate both the client and server side code, as well as the API docs.

I know there is other tooling to help with mocking, validation, etc, but not centrally available, generated by 3rd parties.

That is one area that Swagger suffers from is the fragmentation of tooling, although it has a headstart over RAML and Blueprint, this area hurts it.

I've been trying to account for more of their tooling to identify the pieces of the lifecycle puzzle, but haven't gotten there.

Let me do some more homework this week on it, and wiill post anything I find.

Kin Lane (API Evangelist)

kin...@gmail.com

@kinlane

--

apievangelist.com

apicommons.org

apivoice.com

--

[Jerome Louvel]

This is a bit ahead of what is available in production but we are deeply integrating Swagger tooling inside APISpark cloud platform. We can already generate a Swagger definition from a Web API crafted/designed via APISpark web IDE as we needed it for our API Commons integration (see this blog post).

We also have features under development generating a deep Swagger definition (validated with Swagger UI) and are adding the generation of client SDKs and server stubs for download, based on Swagger codegen module. We plan to release some of this in production for Gluecon conference next week, so stay tuned and feel free to start crafting your web API using APISpark.

In addition, we have started working on the bottom-up chain as well in Restlet Framework to introspect existing web APIs (current based on Restlet API, with JAX-RS API underway and then Spring REST, Swagger Annotations and Google Cloud Endpoints APIs support). The goal is to help developers document then manage their existing web APIs, taking advantage of "Swagger as a Service" capabilities in APISpark as well. See user guide page of APISpark extension.

Best,

Jérôme

http://restlet.org

@jlouvel

[tony tam]

Good 'ol YAML works well for designing APIs and passing them off to client & server teams.  See here:

https://github.com/wordnik/swagger-codegen/wiki/Creating-Swagger-JSON-from-YAML-files

You can also use SoapUI to model the APIs, mock them, and export in swagger JSON format.

Finally, there is formal, comprehensive support around the corner that lets the spec drive client & server implementations.  It'll be posted to this group in the next week or so.