Swagger: A simple, open standard for describing REST APIs with JSON

The example demonstrates an RPC-style HTTP API with pretty URLs. There's no hypermedia in sight. Oh well, we'll figure it out one day...<p>That being said, this is exactly the sort of documentation that's helpful for this kind of API.

This is similar in spirit to the Google APIs Discovery Service, an API to describe recent Google APIs. <a href="http://code.google.com/apis/discovery/v1/using.html" rel="nofollow">http://code.google.com/apis/discovery/v1/using.html</a><p>This is used to power the APIs Explorer, and code/documentation generation for client libraries:<p>* APIs Explorer: <a href="https://code.google.com/apis/explorer" rel="nofollow">https://code.google.com/apis/explorer</a><p>* JavaDoc for the generated Java library for Calendar API: <a href="http://javadoc.google-api-java-client.googlecode.com/hg/apis/calendar/v3/index.html" rel="nofollow">http://javadoc.google-api-java-client.googlecode.com/hg/apis...</a><p>* PyDoc for the Python library: <a href="http://api-python-client-doc.appspot.com/calendar/v3" rel="nofollow">http://api-python-client-doc.appspot.com/calendar/v3</a>

Not a new idea, but it seems a pretty implementation. I've played with Spore a little in the past: <a href="https://github.com/spore" rel="nofollow">https://github.com/spore</a><p>Client implementations include:<p>- Perl: <a href="https://github.com/franckcuny/net-http-spore" rel="nofollow">https://github.com/franckcuny/net-http-spore</a><p>- JS (Node): <a href="https://github.com/francois2metz/node-spore" rel="nofollow">https://github.com/francois2metz/node-spore</a><p>- Lua: <a href="https://github.com/fperrad/lua-Spore" rel="nofollow">https://github.com/fperrad/lua-Spore</a><p>- Ruby: <a href="https://github.com/sukria/Ruby-Spore" rel="nofollow">https://github.com/sukria/Ruby-Spore</a><p>- Clojure: <a href="https://github.com/ngrunwald/clj-spore" rel="nofollow">https://github.com/ngrunwald/clj-spore</a>

While documentation is good, I still don't get the need for programmatic documentation.<p>I suppose the desire is to have a service describing itself so proxies can be code gen'd, but I'm glad I've stepped away from that world and don't miss the WSDL days.

jschema and jschema-rpc both look much nicer:<p><a href="http://jschema.org/" rel="nofollow">http://jschema.org/</a><p><a href="http://jschema.org/rpc.html" rel="nofollow">http://jschema.org/rpc.html</a>

I think this is a really good idea. So far I have been using Enunciate to do exactly this (<a href="http://www.sonatype.com/people/2010/02/documenting-the-nexus-rest-api-with-enunciate/" rel="nofollow">http://www.sonatype.com/people/2010/02/documenting-the-nexus...</a>). I have been happy with Enunciate so far but they seem to have lost traction and their API does not work with Java 7 for instance. Swagger looks a bit cooler too ;)<p>That being said, there are some thing that they do that Swagger seems to be missing (or I am just missing it). For instance Enunciate does not require any custom annotations but uses the normal Javadoc instead, which is a very good feature. And how do I run Swagger, can I plug this into my Maven build process and include in the generated war file?

I vehemently detest this name.

Does anyone know of a tool that can take a API type schema and can actually generate the API for you?<p>I'm talking about a simple CRUD type APIs for quick development. Ideally it would have user sign up and simple field validation baked in.

I'll just leave this here in case anyone still cares...<p><a href="http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm" rel="nofollow">http://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch...</a>

I like the name at least.

I was excited until I saw it was written in Java.

I like this, but it's the third time the link has been submitted.