swagger.json

{
  "swagger": "2.0",
  "info": {
    "description": "node-api-template",
    "version": "1.0.0",
    "title": "node-api-template",
    "contact": {
      "email": "wuhd@cn.ibm.com"
    }
  },
  "tags": [
    {
      "name": "animal",
      "description": "动物"
    }
  ],
  "schemes": [
    "http",
    "https"
  ],
  "paths": {
    "/api/animal": {
      "get": {
        "tags": [
          "animal"
        ],
        "summary": "获取所有动物",
        "description": "获取所有动物",
        "operationId": "getAllAnimals",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Animal"
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "animal"
        ],
        "summary": "获取所有动物",
        "description": "获取所有动物",
        "operationId": "getAllAnimals",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "新增东西",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Animal"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
                "$ref": "#/definitions/Animal"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Animal": {
      "type": "object",
      "required":[
        "name",
        "age"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "名字"
        },
        "age": {
          "type": "integer",
          "format": "int32",
          "description": "年龄"
        }
      }
    }
  }
}