rawmind/express-autodoc

View on GitHub
examples/withRouter/swagger_output.json

Summary

Maintainability
Test Coverage
{
  "swagger": "2.0",
  "host": "localhost",
  "schemes": [
    "http"
  ],
  "security": [
    {
      "ApiKeyAuth": [],
      "OrgHeader": []
    }
  ],
  "paths": {
    "/api/v1/song/{id}": {
      "get": {
        "description": "Get song by ID",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/songs/song/{id}": {
      "get": {
        "description": "Get song by ID (router)",
        "parameters": [
          {
            "description": "The song id",
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "description": "Updates a new song (router)",
        "parameters": [
          {
            "description": "The song id",
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/songs/song/{id}/*": {
      "put": {
        "description": "Insert a new song (router)",
        "parameters": [
          {
            "description": "The song id",
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/api/songs/song/{id}": {
      "get": {
        "description": "Get song by ID (router)",
        "parameters": [
          {
            "description": "The song id",
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "post": {
        "description": "Updates a new song (router)",
        "parameters": [
          {
            "description": "The song id",
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/v2/api/songs/song/{id}/*": {
      "put": {
        "description": "Insert a new song (router)",
        "parameters": [
          {
            "description": "The song id",
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  }
}