swagger.yaml

tags:
  - name: auth
    description: auth API
  - name: users
    description: users API
  - name: products
    description: products API
  - name: categories
    description: categories API

paths:
  # [GET] users
  /users:
    get:
      tags:
        - users
      summary: Find All Users
      responses:
        200:
          description: "OK"
        500:
          description: "Server Error"

    # [POST] users
    post:
      tags:
        - users
      summary: Add User
      parameters:
        - name: body
          in: body
          description: user Data
          required: true
          schema:
            $ref: "#/definitions/users"
      responses:
        201:
          description: "Created"
        400:
          description: "Bad Request"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

  # [GET] users/id
  /users/{id}:
    get:
      tags:
        - users
      summary: Find User By Id
      parameters:
        - name: id
          in: path
          description: User Id
          required: true
          type: integer
      responses:
        200:
          description: "OK"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

    # [PUT] users/id
    put:
      tags:
        - users
      summary: Update User By Id
      parameters:
        - name: id
          in: path
          description: user Id
          required: true
          type: integer
        - name: body
          in: body
          description: user Data
          required: true
          schema:
            $ref: "#/definitions/users"
      responses:
        200:
          description: "OK"
        400:
          description: "Bad Request"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

    # [DELETE] users/id
    delete:
      tags:
        - users
      summary: Delete User By Id
      parameters:
        - name: id
          in: path
          description: user Id
          required: true
          type: integer
      responses:
        200:
          description: "OK"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

  # [GET] products
  /products:
    get:
      tags:
        - products
      summary: Find All Products
      responses:
        200:
          description: "OK"
        500:
          description: "Server Error"

    # [POST] products
    post:
      tags:
        - products
      summary: Add Product
      parameters:
        - name: body
          in: body
          description: product Data
          required: true
          schema:
            $ref: "#/definitions/products"
      responses:
        201:
          description: "Created"
        400:
          description: "Bad Request"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

  # [GET] products/id
  /products/{id}:
    get:
      tags:
        - products
      summary: Find Product By Id
      parameters:
        - name: id
          in: path
          description: Product Id
          required: true
          type: integer
      responses:
        200:
          description: "OK"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

    # [PUT] products/id
    put:
      tags:
        - products
      summary: Update Product By Id
      parameters:
        - name: id
          in: path
          description: product Id
          required: true
          type: integer
        - name: body
          in: body
          description: product Data
          required: true
          schema:
            $ref: "#/definitions/products"
      responses:
        200:
          description: "OK"
        400:
          description: "Bad Request"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

    # [DELETE] products/id
    delete:
      tags:
        - products
      summary: Delete Product By Id
      parameters:
        - name: id
          in: path
          description: product Id
          required: true
          type: integer
      responses:
        200:
          description: "OK"
        409:
          description: "Conflict"
        500:
          description: "Server Error"

# definitions
definitions:
  users:
    type: object
    required:
      - email
      - password
    properties:
      email:
        type: string
        description: user Email
      password:
        type: string
        description: user Password

schemes:
  - https
  - http