What is swagger ?

Developers "LOVE" documentation

What is swagger ?

open source framework

Large ecosystem of tools that helps you to:

design
build
document
consume your RESTful APIs.

Who use swagger ?

Swagger Specification

http://docs.swagger.io/spec.html

Swagger Specification

paths:
 /campaigns:
    get:
      tags:
        - campaign
      summary: List all campaign
      description: ""
      operationId: campaign.list_campaigns
      consumes:
        - application/json
      produces:
        - application/json
      responses:
        "200":
          description: Invalid input
          schema:
            $ref: "#/definitions/Campaigns"

Swagger Specification

"paths": {
  "/build": {
    "post": {
      "operationId": "StartBuild",
      "responses": {
        "200": {
          "description": "",
          "schema": {
            "$ref": "#/definitions/apiBuildResponse"
          }
        }
      },
      "parameters": [
        {
          "name": "build_request",
          "in": "body",
          "required": true,
          "schema": {
            "$ref": "#/definitions/apiBuildRequest"
          }
        }
}
      ]
    }

Swagger tools

Editor

http://editor.swagger.io

Swagger tools

Codegen

Swagger tools

Open Source Integrations

http://swagger.io/open-source-integrations/

Demo