OpenAPI Spec in HCL

petstore-minimal-optimized.hcl

swagger = "2.0"

info {
  version          = "1.0.0"
  title            = "Swagger Petstore"
  description      = "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
  terms_of_service = "http://swagger.io/terms"

  contact {
    name = "Swagger API Team"
  }

  license {
    name = "MIT"
  }
}

host = "petstore.swagger.io"

base_path = "/api"

schemes = ["http"]

consumes = ["application/json"]

produces = ["application/json"]

path "/pet" {
  get {
    description = "Returns all pets from the system that the user has access to"
    produces    = ["application/json"]

    response "200" {
      description = "A list of pets."

      schema {
        type = "array"

        items {
          "$ref" = "${definition.pet}"
        }
      }
    }
  }
}

definition "pet" {
  type     = "object"
  required = ["id", "name"]

  properties {
    id {
      type   = "integer"
      format = "int64"
    }

    name {
      type = "string"
    }

    tag {
      type = "string"
    }
  }
}

petstore-minimal-unoptimized.hcl

swagger = "2.0"

info {
  version        = "1.0.0"
  title          = "Swagger Petstore"
  description    = "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
  termsOfService = "http://swagger.io/terms"

  contact {
    name = "Swagger API Team"
  }

  license {
    name = "MIT"
  }
}

host = "petstore.swagger.io"

basePath = "/api"

schemes = ["http"]

consumes = ["application/json"]

produces = ["application/json"]

paths {
  "/pets" {
    get {
      description = "Returns all pets from the system that the user has access to"
      produces    = ["application/json"]

      responses {
        "200" {
          description = "A list of pets."

          schema {
            type = "array"

            items {
              "$ref" = "#/definitions/Pet"
            }
          }
        }
      }
    }
  }
}

definitions {
  Pet {
    type     = "object"
    required = ["id", "name"]

    properties {
      id {
        type   = "integer"
        format = "int64"
      }

      name {
        type = "string"
      }

      tag {
        type = "string"
      }
    }
  }
}

petstore-minimal.conf

// HOCON

swagger = "2.0"

info {
  version          = "1.0.0"
  title            = "Swagger Petstore"
  description      = "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
  terms_of_service = "http://swagger.io/terms"

  contact {
    name = "Swagger API Team"
  }

  license {
    name = "MIT"
  }
}

host = "petstore.swagger.io"

base_path = "/api"

schemes = ["http"]

consumes = ["application/json"]

produces = ["application/json"]

paths {
  "/pet" {
     get {
      description = "Returns all pets from the system that the user has access to"
      produces    = ["application/json"]

      response "200" {
        description = "A list of pets."

        schema {
          type = "array"

          items {
            "$ref" = "${definition.pet}"
          }
        }
      }
    }
  }
}

definitions {
  pet {
    type     = "object"
    required = ["id", "name"]

    properties {
      id {
        type   = "integer"
        format = "int64"
      }

      name {
        type = "string"
      }

      tag {
        type = "string"
      }
    }
  }
}

petstore-minimal.yaml

---
  swagger: "2.0"
  info: 
    version: "1.0.0"
    title: "Swagger Petstore"
    description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
    termsOfService: "http://swagger.io/terms/"
    contact: 
      name: "Swagger API Team"
    license: 
      name: "MIT"
  host: "petstore.swagger.io"
  basePath: "/api"
  schemes: 
    - "http"
  consumes: 
    - "application/json"
  produces: 
    - "application/json"
  paths: 
    /pets: 
      get: 
        description: "Returns all pets from the system that the user has access to"
        produces: 
          - "application/json"
        responses: 
          "200":
            description: "A list of pets."
            schema: 
              type: "array"
              items: 
                $ref: "#/definitions/Pet"
  definitions: 
    Pet: 
      type: "object"
      required: 
        - "id"
        - "name"
      properties: 
        id: 
          type: "integer"
          format: "int64"
        name: 
          type: "string"
        tag: 
          type: "string"