Sample Swagger Spec for a Yelp API

sample-yelp-api-specs.json

{
  "definitions": {
    "Category": {
      "description": "A Category used to group businesses",
      "properties": {
        "id": {
          "description": "Unique ID of the Category",
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "description": "Name of this Category",
          "type": "string"
        }
      },
      "type": "object"
    },
    "Business": {
      "description": "Represents a specific Business on Yelp",
      "properties": {
        "category": {
          "$ref": "#/definitions/Category",
          "description": "Optional category of the business"
        },
        "id": {
          "description": "Unique ID of this Business",
          "format": "int64",
          "type": "integer"
        },
        "name": {
          "description": "Name of this specific Business",
          "type": "string"
        },
        "photoUrls": {
          "description": "Photo URls for this Business",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "status": {
          "description": "Status of this Business on Yelp",
          "enum": [
            "OPEN",
            "PERMANENTLY_CLOSED",
            "TEMPORARILY_CLOSED"
          ],
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ],
      "type": "object"
    }
  },
  "info": {
    "description": "This is a sample API used for code generation.",
    "title": "Yelp Sample Businesses API",
    "version": "1.0.0"
  },
  "paths": {
    "/business/{businessId}": {
      "get": {
        "description": "Returns a single Business by its ID",
        "operationId": "getBusinessById",
        "parameters": [
          {
            "description": "ID of Business to search for",
            "format": "int64",
            "in": "path",
            "name": "businessId",
            "required": true,
            "type": "integer"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/Business"
            }
          }
        },
        "summary": "Find business by ID"
      }
    }
  },
  "swagger": "2.0"
}