swagger.yaml

openapi: 3.0.0
info:
  title: API de Gerenciamento de Instâncias e Envio de Mensagens
  description: API para criar e gerenciar instâncias do WhatsApp e enviar mensagens através delas.
  version: 1.0.0
servers:
  - url: http://localhost:3000
    description: Servidor local

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

  schemas:
    Instance:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: "123e4567-e89b-12d3-a456-426614174000"
        name:
          type: string
          example: "Instância 1"
        auth:
          type: boolean
          example: false
        qrCode:
          type: string
          example: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."

    Message:
      type: object
      properties:
        id:
          type: integer
          example: 1
        instanceId:
          type: string
          format: uuid
          example: "123e4567-e89b-12d3-a456-426614174000"
        name:
          type: string
          example: "Instância 1"
        phone:
          type: string
          example: "5511998765432"
        message:
          type: string
          example: "Olá, esta é uma mensagem de teste."
        success:
          type: boolean
          example: true
        date:
          type: string
          format: date-time
          example: "2024-11-28T16:15:37-03:00"

security:
  - bearerAuth: []

paths:
  /instances:
    post:
      tags:
        - Instâncias
      summary: Adiciona uma nova instância do WhatsApp
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: "Instância 1"
              required:
                - name
      responses:
        '200':
          description: Instância criada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Instância criada com sucesso"
                  data:
                    $ref: '#/components/schemas/Instance'
        '400':
          description: Requisição inválida
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "O campo 'name' é obrigatório."

    get:
      tags:
        - Instâncias
      summary: Lista todas as instâncias
      security:
        - bearerAuth: []
      responses:
        '200':
          description: Lista de instâncias
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Lista de instâncias"
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Instance'

  /instances/{id}:
    get:
      tags:
        - Instâncias
      summary: Obtém detalhes de uma instância específica
      security:
        - bearerAuth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          example: "123e4567-e89b-12d3-a456-426614174000"
      responses:
        '200':
          description: Detalhes da instância
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Detalhes da instância"
                  data:
                    $ref: '#/components/schemas/Instance'
        '404':
          description: Instância não encontrada
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Instância não encontrada"

    delete:
      tags:
        - Instâncias
      summary: Deleta uma instância específica
      security:
        - bearerAuth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          example: "123e4567-e89b-12d3-a456-426614174000"
      responses:
        '200':
          description: Instância deletada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Instância 123e4567-e89b-12d3-a456-426614174000 deletada com sucesso"
        '404':
          description: Instância não encontrada
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Instância não encontrada"

  /messages:
    post:
      tags:
        - Mensagens
      summary: Envia uma mensagem através de uma instância específica
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                instanceId:
                  type: string
                  format: uuid
                  example: "123e4567-e89b-12d3-a456-426614174000"
                phone:
                  type: string
                  example: "5511998765432"
                message:
                  type: string
                  example: "Olá, esta é uma mensagem de teste."
              required:
                - instanceId
                - phone
                - message
      responses:
        '200':
          description: Mensagem enviada com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: "Mensagem enviada com sucesso."
                  data:
                    type: object
                    properties:
                      phone:
                        type: string
                        example: "5511998765432"
                      message:
                        type: string
                        example: "Olá, esta é uma mensagem de teste."
                      response:
                        type: object
                        example: {}
        '403':
          description: Instância não autenticada
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: "Instância não autenticada. Por favor, autentique-se antes de enviar mensagens."
        '404':
          description: Instância ou número não encontrado
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  message:
                    type: string
                    example: "Erro ao enviar mensagem."
                  error:
                    type: string
                    example: "Detalhes técnicos do erro."
  /messages/history:
    get:
      tags:
        - Mensagens
      summary: Retorna o histórico de mensagens
      security:
        - bearerAuth: []
      responses:
        '200':
          description: Histórico de mensagens recuperado com sucesso
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Message'
        '401':
          description: Token de autenticação não fornecido
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Token de autenticação não fornecido."
        '403':
          description: Token de autenticação inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: "Token de autenticação inválido ou expirado."