business-api

business.yaml

openapi: 3.0.0
components:
  schemas:
    Business:
      type: object
      properties:
        name:
          description: the name of the business
          type: string
        url:
          description: the URL of the business
          type: string
        categories:
          description: the categories this business belongs to
          type: array
          default: [ ]
          items:
            $ref: '#/components/schemas/Category'
        location:
          description: the pyhysical address of the business
          type: object
          $ref: '#/components/schemas/Location'
        hours:
          description: the hours of operation for this business
          type: array
          default: [ ]
          items:
            $ref: '#/components/schemas/Hour'

    Category:
      type: object
      properties:
        title:
          description: name of the category
          example: Thai
          type: string

    Location:
      type: object
      properties:
        address1:
          description: the address1 for the business
          type: string
        address2:
          description: the address2 for the business
          type: string
        address3:
          description: the address3 for the business
          type: string
        city:
          description: the city for the business
          type: string
        state:
          description: the state where business is located
          type: string
        postal_code:
          description: the postal code for the business
          type: string

    Hour:
      type: object
      properties:
        hours_type:
          description: Is this business has regular or special hours
          type: string

businesses.yaml

openapi: 3.0.0
components:
  schemas:
    Businesses:
      type: array
      default: []
      items:
        $ref: './business.yaml#/components/schemas/Business'

spec.yaml

openapi: 3.0.0
info:
  title: Businesses API
  description: Information about businesses
  version: 0.0.1
servers:
  - url: https://api.businesses.com/
paths:
  /businesses:
    get:
      summary: Returns 50 businesses
      responses:
        '200':
          description: A JSON object with the results
          content:
            application/json:
              schema:
                $ref: './schema/businesses.yaml#/components/schemas/Businesses'
  /business/random:
    get:
      summary: Returns a random business from a list of 50 businesses
      responses:
        '200':
          description: A JSON object for a random business
          content:
            application/json:
              schema:
                $ref: './schema/business.yaml#/components/schemas/Business'