Modulo_3_API/Swagger_API.x-yaml at master · antoniogarcon/Modulo_3_API · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
openapi: 3.0.0
info:
  title: API de Gerenciamento de Tarefas
  description: Documentação da API para o gerenciamento de tarefas (To-Do List)
  version: 1.0.0
servers:
  - url: http://127.0.0.1:5000
    description: Servidor de Desenvolvimento
paths:
  /tasks:
    get:
      summary: Obter todas as tarefas
      responses:
        '200':
          description: Lista de tarefas obtida com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  tasks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        description:
                          type: string
                        completed:
                          type: boolean
                  total_tasks:
                    type: integer
    post:
      summary: Criar nova tarefa
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                description:
                  type: string
              required:
                - title
      responses:
        '200':
          description: Nova tarefa criada com sucesso
  '/tasks/{taskId}':
    put:
      summary: Atualizar tarefa existente
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Dados da tarefa a serem atualizados
              properties:
                title:
                  type: string
                description:
                  type: string
                completed:
                  type: boolean
              required:
                - title
      parameters:
        - name: taskId
          in: path
          description: ID da tarefa a ser atualizada
          required: true
          schema:
            type: integer

      responses:
        '200':
          description: Tarefa atualizada com sucesso
    delete:
      summary: Deletar tarefa existente
      parameters:
        - name: taskId
          in: path
          description: ID da tarefa a ser deletada
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Tarefa deletada com sucesso