openapi.yaml

openapi: 3.0.1
info:
  title: API для магазина электроники
  description: >-
    Tренировочное АПИ для просмотра товаров "ноутбуки" и "телефоны" с
    возможностью добавлять товары (метод POST)
  version: 1.0.0
  contact:
    name: Ayrat Sungatullin
    url: https://github.com/DIMANVAZ/API_swagger_training
    email: dimanvaz04@gmail.com
servers:
  - url: http://localhost:8080/
    description: основной сервер на локалхосте
paths:
  /:
    get:
      description: Получить JSON-список всех товаров
      summary: получить все товары
      tags:
        - Все товары
      responses:
        '200':
          description: Успешно
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/allGoods'
  /phones:
    get:
      description: Получить JSON-список телефонов
      summary: получить все телефоны
      tags:
        - Телефоны
      responses:
        '200':
          description: Список телефонов
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/phones'
    post:
      description: Добавить телефон в список
      summary: добавить телефон
      tags:
        - Телефоны
      requestBody:
        required: true
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/phone'
      responses:
        '201':
          description: Успешно добавлен
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/phones'
        '400':
          description: Ошибка при добавлении предмета. Переданы некорректные данные
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
        '404':
          description: Ошибка в адресе (нет такой категории)
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
    patch:
      description: Обновить информацию по телефону по id
      summary: обновить инфо о телефоне
      tags:
        - Телефоны
      responses:
        '200':
          description: Успешно обновлён
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/phones'
        '400':
          description: Ошибка при обновлении предмета
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
        '404':
          description: Ошибка в адресе (нет такой категории)
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
    delete:
      description: Удалить предмет (телефон) по id
      summary: удалить телефон
      tags:
        - Телефоны
      responses:
        '200':
          description: Успешно удалён
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/laptops'
        '404':
          description: Ошибка в адресе (нет такой категории)
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
  /laptops:
    get:
      description: Получить JSON-список ноутбуков
      summary: получить все ноутбуки
      tags:
        - Ноутбуки
      responses:
        '200':
          description: Успешно
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/laptops'
    post:
      description: Добавить ноутбук в список
      summary: добавить ноутбук
      tags:
        - Ноутбуки
      requestBody:
        required: true
        content:
          application/json;charset=UTF-8:
            schema:
              $ref: '#/components/schemas/laptop'
      responses:
        '201':
          description: Успешно добавлен
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/laptops'
        '400':
          description: Ошибка при добавлении предмета. Переданы некорректные данные
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
        '404':
          description: Ошибка в адресе (нет такой категории)
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
    patch:
      description: Обновить информацию по ноутбуку по id
      summary: обновить инфо по ноутбуку
      tags:
        - Ноутбуки
      responses:
        '200':
          description: Успешно обновлён
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/laptops'
        '400':
          description: Ошибка при обновлении предмета
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
        '404':
          description: Ошибка в адресе (нет такой категории)
          content:
            application/json;charset=UTF-8:
              schema:
                type: string
    delete:
      description: Удалить предмет (ноутбук) по id
      summary: удалить ноутбук
      tags:
        - Ноутбуки
      responses:
        '200':
          description: Успешно удалён
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: '#/components/schemas/laptops'
        '404':
          description: Ошибка в адресе (нет такой категории)
          content:
            application/json;charset=UTF-8:
              schema:
                type: string

components:
  schemas:
    phone:
      type: object
      required:
        - brand
        - model
        - price
        - sim
        - condition
      properties:
        brand:
          description: производитель
          type: string
          example: Samsung
        model:
          description: модель
          type: string
          example: Galaxy S10
        price:
          description: цена
          type: number
          example: 50 000
        sim:
          description: количество сим-карт
          type: number
          example: 2
        condition:
          description: состояние товара
          type: string
          enum:
            - new
            - used
            - broken
          example: new
    laptop:
      type: object
      required:
        - brand
        - model
        - price
        - diagonal
        - condition
      properties:
        brand:
          description: производитель
          type: string
          example: Lenovo
        model:
          description: модель
          type: string
          example: ThinkPad
        price:
          description: цена
          type: number
          example: 50 000
        diagonal:
          description: диагональ экрана
          type: number
          example: 15.6
        condition:
          description: состояние товара
          type: string
          enum:
            - new
            - used
            - broken
          example: new
    phones:
      type: array
      items:
        $ref: '#/components/schemas/phone'
    laptops:
      type: array
      items:
        $ref: '#/components/schemas/laptop'
    allGoods:
      type: object
      properties:
        phones:
          type: array
          items:
            $ref: '#/components/schemas/phone'
        laptops:
          type: array
          items:
            $ref: '#/components/schemas/laptop'