This repository was archived by the owner on Mar 18, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathapiary.apib
285 lines (217 loc) · 8.23 KB
/
apiary.apib
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
FORMAT: 1A
HOST: http://localhost:8080/api/v1
# Gestão de laboratórios
Um simples exemplo de como documentar uma API usando a [*API Blueprint specification*](https://apiblueprint.org/documentation).
Uma opção para editar arquivos `.apib` é o editor Visual Studio Code, com as extensões API Elements extersion e API Blueprint Viewer.
A aplicação [Dredd](https://dredd.org/) é um *framework* para teste de APIs REST. A aplicação lê a sua API documentada (como esse arquivo) e executa passo a passo em um servidor onde tem sua API implementada. Verifica-se aqui se a sua implementação está gerando as respostas descritas na documentação de sua API.
# Group Campi
## Campi [/campi]
### Listar todos os campi da instituição [GET]
+ Response 200 (application/json)
{
"campi": {
"FLN": {
"nome": "Florianópolis",
"sigla": "FLN",
"telefone": "3999-2854",
"blocos": {
"MECANICA": {
"sigla": "mecanica",
"descricao": "ensino",
"laboratorios": {
"LABMAT": {
"nome": "Laboratório de Materiais",
"sigla": "LabMat",
"totalDeLugares": 30,
"tipo": "HARDWARE"
}
}
}
}
},
"SJE": {
"nome": "São José",
"sigla": "SJE",
"telefone": "3381-2854",
"blocos": {
"BLOCOB": {
"sigla": "blocoB",
"descricao": "ensino",
"laboratorios": {
"LABSIDI": {
"nome": "Laboratório de Sistemas Digitais",
"sigla": "LabSiDi",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
},
"LABRECOM": {
"nome": "Laboratório de Redes de Computadores",
"sigla": "LabReCom",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
}
}
},
"BLOCOA": {
"sigla": "blocoA",
"descricao": "administracao",
"laboratorios": {}
}
}
}
}
}
### Criar novo campus [POST]
Para adicionar um novo campus na coleção. Recebe um objeto JSON contendo os dados de um campus.
+ nome (string) - Nome do campus
+ sigla (string) - Sigla do campus
+ telefone (string) - Telefone do campus
+ Request (application/json)
{
"nome": "São José",
"sigla": "SJE",
"telefone": "3381-2854"
}
+ Response 201
+ Headers
Location: /campi/SJE
+ Body
## Campus [/campi/{sigla_campus}]
A `sigla_campus` deve ser informada.
+ Parameters
+ sigla_campus: SJE (string) - Sigla do campus
### Detalhes de um campus [GET]
+ Response 200 (application/json)
{
"nome": "São José",
"sigla": "SJE",
"telefone": "3381-2854",
"blocos": {
"BLOCOB": {
"sigla": "blocoB",
"descricao": "ensino",
"laboratorios": {
"LABSIDI": {
"nome": "Laboratório de Sistemas Digitais",
"sigla": "LabSiDi",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
},
"LABRECOM": {
"nome": "Laboratório de Redes de Computadores",
"sigla": "LabReCom",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
}
}
},
"BLOCOA": {
"sigla": "blocoA",
"descricao": "administracao",
"laboratorios": {}
}
}
}
## Blocos [/campi/{sigla_campus}/blocos]
+ Parameters
+ sigla_campus: SJE (string) - Sigla do campus
### Lista todos os blocos de um campus [GET]
+ Response 200 (application/json)
{
"BLOCOB": {
"sigla": "blocoB",
"descricao": "ensino",
"laboratorios": {
"LABSIDI": {
"nome": "Laboratório de Sistemas Digitais",
"sigla": "LabSiDi",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
},
"LABRECOM": {
"nome": "Laboratório de Redes de Computadores",
"sigla": "LabReCom",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
}
}
},
"BLOCOA": {
"sigla": "blocoA",
"descricao": "administracao",
"laboratorios": {}
}
}
### Criar novo bloco [POST]
Para adicionar um novo bloco a um campus na coleção. Recebe um objeto JSON contendo os dados de um bloco.
+ sigla (string) - Sigla do bloco
+ descricao (string) - Descrição do bloco
+ Request (application/json)
{
"sigla": "blocoA",
"descricao" : "administracao"
}
+ Response 201
+ Headers
Location: /blocos/blocoA
+ Body
## Bloco [/campi/{sigla_campus}/blocos/{sigla_bloco}/laboratorios]
+ Parameters
+ sigla_campus: SJE (string) - Sigla do campus
+ sigla_bloco: blocoB (string) - Sigla do bloco
### Lista todos os laboratórios do bloco de um campus [GET]
+ Response 200 (application/json)
{
"laboratorios": {}
}
### Criar novo laboratório [POST]
Para adicionar um novo laboratório a um bloco de um campus. Recebe um objeto JSON contendo os dados de um laboratório.
+ sigla (string) - Sigla do laboratório
+ nome (string) - Nome do laboratório
+ totalDeLugares (number) - total de postos de trabalho
+ tipo (string) - SOFTWARE ou HARDWARE
+ Request (application/json)
{
"sigla": "LabReCom",
"nome" : "Laboratório de Redes de Computadores",
"totalDeLugares" : "24",
"tipo" : "SOFTWARE"
}
+ Response 201
+ Headers
Location: /laboratorios/LabReCo
+ Body
## Laboratório [/campi/{sigla_campus}/blocos/{sigla_bloco}/laboratorios/{sigla_laboratorio}]
+ Parameters
+ sigla_campus: SJE (string) - Sigla do campus
+ sigla_bloco: blocoB (string) - Sigla do bloco
+ sigla_laboratorio: LabSiDi (string) - Sigla do laboratório
### Detalhes de um laboratório de um bloco de um campus [GET]
+ Response 200 (application/json)
{
"LABSIDI": {
"nome": "Laboratório de Sistemas Digitais",
"sigla": "LabSiDi",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
},
"LABRECOM": {
"nome": "Laboratório de Redes de Computadores",
"sigla": "LabReCom",
"totalDeLugares": 24,
"tipo": "SOFTWARE"
}
}
### Atualizar dados de um laboratório [PUT]
+ Request (application/json)
{
"sigla": "LabReCo",
"nome" : "Laboratório de Redes de Computadores",
"totalDeLugares" : "30",
"tipo" : "SOFTWARE"
}
+ Response 200 (text/plain)
sucesso
### Excluir um laboratório [DELETE]
+ Response 200 (text/plain)
sucesso