To start writing a Swagger spec, you simply open the online Swagger Editor and start writing according to the Swagger specification. Auto-generate Code: You can auto-generate client and server code (interface part) based on the Swagger spec, which makes sure that they are consistent.Plus there is a built-in way to actually call the services, so the API user won’t need to use an external tool to play around with the services, but can just do it inside the documentation.

Beautiful Documentation: The customer-facing documentation looks really nice.

Huge Community: There’s a great community around Swagger, so when you face a problem, you can usually just Google the solution.

So most of the complicated things, like security or reusing resource definitions across several methods, are already handled gracefully by the standard.

Designed for REST: Swagger is really easy to use, because it’s a single-purpose tool for documenting REST Services.

It also means that the API user has probably already experience with Swagger, which dramatically reduces the learning curve. This means that it’s already used in real production APIs, so you don’t have to be the beta tester.

Industry Standard: Swagger is the most widely adopted documentation and specification standard for REST Services.

There are 5 good reasons for using Swagger: Why use Swagger?īut why not use another standard (like RAML) or simply open your favorite word processor and start hitting the keys? The real power of the Swagger standard comes from the ecosystem of powerful tools that surrounds it.įor example, there’s Swagger Editor for writing the Swagger spec, Swagger Codegen for automatically generating code based on your Swagger spec, and Swagger UI for turning your Swagger spec into beautiful documentation that your API users will love to read.

Swagger is the most widely used standard for specifying and documenting REST Services.

How to use swagger editor