-
Notifications
You must be signed in to change notification settings - Fork 0
/
server.js
232 lines (212 loc) · 6.93 KB
/
server.js
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
const express = require("express");
const app = express();
const port = 3000;
const swaggerUi = require("swagger-ui-express");
const swaggerJsdoc = require("swagger-jsdoc");
// Defina as opções do Swagger
let options = {
swaggerDefinition: {
openapi: "3.0.0",
info: {
title: "API CRUD com Swagger e Node.js",
version: "1.0.0",
description: "API de testes com Swagger",
},
servers: [
{
url: `http://localhost:${port}`,
description: "Servidor Local",
},
],
},
apis: ["./server.js"], // O arquivo que contém suas rotas
};
const swaggerSpec = swaggerJsdoc(options);
// Middleware para servir a documentação Swagger UI
app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerSpec));
// Dados de exemplo
let data = [
{
id: 1,
name: "Fernando Terceros",
username: "jci_terceros",
email: "[email protected]",
},
];
app.get("/", (req, res) => {
res.send(`
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>O que é uma API REST?</title>
</head>
<body>
<h1>O que é uma API REST?</h1>
<p>API REST, ou <strong>Arquitetura de Transferência de Estado Representacional</strong>, é um conjunto de princípios e convenções para projetar e interagir com serviços web. É amplamente usado na construção de aplicativos web e móveis.</p>
<h2>Principais Características de uma API REST:</h2>
<ul>
<li><strong>Recursos:</strong> Tudo em uma API REST é considerado um recurso, como usuários, produtos ou posts.</li>
<li><strong>Verbos HTTP:</strong> Ela utiliza os verbos HTTP (GET, POST, PUT, DELETE) para realizar operações nos recursos.</li>
<li><strong>Stateless:</strong> Cada requisição para a API deve conter todas as informações necessárias, tornando a API independente de estado.</li>
<li><strong>Representações:</strong> Os recursos podem ser representados em diferentes formatos, como JSON ou XML.</li>
<li><strong>URI (Uniform Resource Identifier):</strong> Cada recurso é acessado por meio de uma URI única.</li>
<li><strong>HATEOAS:</strong> Uma API REST pode incluir links para recursos relacionados, permitindo a descoberta dinâmica de endpoints.</li>
</ul>
<h2>Vantagens de Usar uma API REST:</h2>
<ul>
<li>Simplicidade e fácil compreensão.</li>
<li>Integração com várias plataformas e linguagens.</li>
<li>Escalabilidade e flexibilidade.</li>
<li>Padrão amplamente adotado na indústria.</li>
</ul>
<p>Em resumo, uma API REST é uma abordagem padrão para a criação de serviços web que é simples, escalável e amplamente aceita na indústria de desenvolvimento de software.</p>
<h2>API de testes com Swagger</h2>
<p>Veja a <a href="/api-docs">documentação</a>.</p>
</body>
</html>
`);
});
/**
* @swagger
* /api/users:
* get:
* summary: Retorna todos os usuários
* description: Retorna todos os usuários da API.
* responses:
* '200':
* description: Sucesso - Retorna a lista de usuários.
*/
app.get("/api/users", (req, res) => {
res.json(data);
});
/**
* @swagger
* /api/users:
* post:
* summary: Cria um novo usuário
* description: Cria um novo usuário com os dados fornecidos.
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* name:
* type: string
* username:
* type: string
* email:
* type: string
* responses:
* '201':
* description: Sucesso - Retorna o usuário criado.
*/
app.post("/api/users", (req, res) => {
const newUser = req.body;
newUser.id = data.length + 1;
data.push(newUser);
res.status(201).json(newUser);
});
/**
* @swagger
* /api/users/{id}:
* get:
* summary: Retorna um usuário pelo ID
* description: Retorna um usuário específico com base no ID fornecido.
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: ID do usuário a ser retornado.
* responses:
* '200':
* description: Sucesso - Retorna o usuário com o ID especificado.
* '404':
* description: Usuário não encontrado.
*/
app.get("/api/users/:id", (req, res) => {
const userId = parseInt(req.params.id);
const user = data.find((u) => u.id === userId);
if (!user) {
return res.status(404).json({ error: "Usuário não encontrado." });
}
res.json(user);
});
/**
* @swagger
* /api/users/{id}:
* put:
* summary: Atualiza um usuário pelo ID
* description: Atualiza um usuário existente com base no ID fornecido.
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: ID do usuário a ser atualizado.
* requestBody:
* required: true
* content:
* application/json:
* schema:
* type: object
* properties:
* name:
* type: string
* username:
* type: string
* email:
* type: string
* responses:
* '200':
* description: Sucesso - Retorna o usuário atualizado.
* '404':
* description: Usuário não encontrado.
*/
app.put("/api/users/:id", (req, res) => {
const userId = parseInt(req.params.id);
const updatedUser = req.body;
const existingUserIndex = data.findIndex((u) => u.id === userId);
if (existingUserIndex === -1) {
return res.status(404).json({ error: "Usuário não encontrado." });
}
data[existingUserIndex] = { ...data[existingUserIndex], ...updatedUser };
res.json(data[existingUserIndex]);
});
/**
* @swagger
* /api/users/{id}:
* delete:
* summary: Exclui um usuário pelo ID
* description: Exclui um usuário existente com base no ID fornecido.
* parameters:
* - in: path
* name: id
* required: true
* schema:
* type: integer
* description: ID do usuário a ser excluído.
* responses:
* '204':
* description: Sucesso - Usuário excluído com sucesso.
* '404':
* description: Usuário não encontrado.
*/
app.delete("/api/users/:id", (req, res) => {
const userId = parseInt(req.params.id);
const existingUserIndex = data.findIndex((u) => u.id === userId);
if (existingUserIndex === -1) {
return res.status(404).json({ error: "Usuário não encontrado." });
}
data.splice(existingUserIndex, 1);
res.status(204).send();
});
app.listen(port, () => {
console.log(`API rodando em http://localhost:${port}`);
});