swagger.yaml

tags:
- name: Url Shortener
  description: The url shortener API

paths:
# [POST] encode
  /encode:
    post:
      tags:
      - Shortener
      summary: short(encode) a url
      parameters:
      - name: body
        in: body
        description: The url which we need to shorten
        required: true
        schema:
          $ref: '#/definitions/Urls'
      responses:
        200:
          description: 'Created'
        400:
          description: 'Bad Request'
        500:
          description: 'Server Error'

# [GET] decode
  /decode:
    get:
      tags:
      - Shortener
      summary: The url which we need to decode
      parameters:
      - name: encodedUrl
        in: query
        description: encoded(short) Url
        required: true
        type: string
      responses:
        200:
          description: 'OK'
        400:
          description: 'Bad Request'
        500:
          description: 'Server Error'

# definitions
definitions:
  Urls:
    type: object
    required:
        - url
    properties:
      url:
        type: string
        description: web address

schemes:
 - https
 - http