go-swagger toolkit

Swagger 2.0 describes your API's for you, so you don't have to

_index

Swagger 2.0 This API is not stable yet, when it is stable it will be distributed over gopkg.in There is a code coverage report available in the artifacts section of a build. Unfortunately using coveralls made the build unstable. Contains an implementation of Swagger 2.0. It knows how to serialize and deserialize swagger specifications. Swagger is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger in almost every modern programming language and deployment environment.

21 Oct 2015

about

About There are 3 axis along which your API and its documentation matter. The first one is an artefact of that first meeting where you hash out what your service will do. Hopefully you’ve come up with some document that services as a kind of contract for what the affected people/teams will need to do. At this stage you want to be able to generate a server, perhaps a client to talk to that server.

21 Oct 2015

Spec generation reference

generate spec home

The toolkit has a command that will let you generate a swagger spec document from your code. The command integrates with go doc comments, and makes use of structs when it needs to know of types. Based on the work from https://github.com/yvasiyarov/swagger It uses a similar approach but with expanded annotations and it produces a swagger 2.0 spec. The goal of the syntax is to make it look as a natural part of the documentation for the application code.

9 Nov 2015