japanshippingrates.io yaml for swagger.io

japanshippingrates.yaml

# Japan Shipping Rates API
swagger: '2.0'
info:
  title: Japan Post Shipping Rates API
  description: Move your app forward with the Japan Shipping Rates API
  version: "1.0.0"
# the domain of the service
host: japanshippingrates.io
# array of all schemes that your API supports
schemes:
  - https
# will be prefixed to all paths
basePath: /v1
produces:
  - application/json
paths:
  /rates:
    get:
      summary: Japan Post Rates
      description: |
        Returns an array of `Rate` objects given country, weight and package dimensions
      parameters:
        - name: country
          in: query
          description: Country in ISO2 format
          required: true
          type: string
        - name: weight
          in: query
          description: Weight of the packge in grams
          required: true
          type: number
          format: double
        - name: length
          in: query
          description: Length of the packge in cemtimeters
          required: true
          type: number
          format: double
        - name: width
          in: query
          description: Width of the packge in centimeters
          required: true
          type: number
          format: double
        - name: height
          in: query
          description: Height of the packge in centimeters
          required: true
          type: number
          format: double
      tags:
        - Rates
      responses:
        200:
          description: Successful response
          schema:
            title: ArrayOfRates
            type: array
            items:
              title: Rate
              type: object
              properties:
                name:
                  type: string
                single:
                  type: boolean
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
definitions:
  Error:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      fields:
        type: string