openapi-middleware/tests/helpers/openapi-sample-v3.json

OpenAPI middleware for common api frameworks (pre-release version!)

{
  "openapi": "3.0.0",
  "info": {
    "title": "Sample API",
    "description": "Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.",
    "version": "0.1.0"
  },
  "paths": {
    "/greeting/:pathName": {
      "get": {
        "summary": "Returns a greeting.",
        "x-controller": "greetings",
        "description": "Sample endpoint that returns a greeting.",
        "operationId": "greetingGet",
        "parameters": [
          {
            "name": "qsName",
            "in": "query",
            "required": false,
            "description": "query user name.",
            "schema": {
              "type": "string",
              "minimum": 1
            }
          },
          {
            "name": "pathName",
            "in": "path",
            "required": false,
            "description": "path user name.",
            "schema": {
              "type": "string",
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "responseText": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Returns a greeting",
        "operationId": "greetingCreate",
        "parameters": [
          {
            "name": "qsName",
            "in": "query",
            "required": false,
            "description": "query user name.",
            "schema": {
              "type": "string",
              "minimum": 1
            }
          },
          {
            "name": "pathName",
            "in": "path",
            "required": false,
            "description": "path user name.",
            "schema": {
              "type": "string",
              "minimum": 1
            }
          }
        ],
        "requestBody": {
          "description": "Optional description in *Markdown*",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "bodyName"
                ],
                "properties": {
                  "bodyName": {
                    "type": "string"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Greeting response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "responseText": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  }
}