@syntay/fastay 0.1.3 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -51,7 +51,7 @@ npm run dev:watch
|
|
|
51
51
|
|
|
52
52
|
---
|
|
53
53
|
|
|
54
|
-
Estrutura do Projeto
|
|
54
|
+
**Estrutura do Projeto**
|
|
55
55
|
```bash
|
|
56
56
|
minha-app/
|
|
57
57
|
│
|
|
@@ -86,7 +86,7 @@ minha-app/
|
|
|
86
86
|
└── eslint.config.mjs
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
Explicação das pastas principais
|
|
89
|
+
**Explicação das pastas principais:**
|
|
90
90
|
|
|
91
91
|
`src/api` — Cada pasta representa um grupo de rotas. Todo route.ts dentro é registrado automaticamente.
|
|
92
92
|
|
|
@@ -123,7 +123,7 @@ void (async () => {
|
|
|
123
123
|
|
|
124
124
|
---
|
|
125
125
|
|
|
126
|
-
Opções do `createApp
|
|
126
|
+
**Opções do `createApp`**
|
|
127
127
|
|
|
128
128
|
createApp recebe um único objeto para configurar totalmente a aplicação Fastay.
|
|
129
129
|
|
|
@@ -146,7 +146,7 @@ createApp recebe um único objeto para configurar totalmente a aplicação Fasta
|
|
|
146
146
|
}
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
Exemplos
|
|
149
|
+
**Exemplos:**
|
|
150
150
|
|
|
151
151
|
Aplicar middlewares globais
|
|
152
152
|
|
|
@@ -222,7 +222,7 @@ expressOptions: {
|
|
|
222
222
|
|
|
223
223
|
---
|
|
224
224
|
|
|
225
|
-
Rotas da API
|
|
225
|
+
**Rotas da API**
|
|
226
226
|
|
|
227
227
|
Roteamento baseado em arquivos com sintaxe limpa:
|
|
228
228
|
|
|
@@ -246,7 +246,7 @@ Tipado e compatível com TypeScript.
|
|
|
246
246
|
|
|
247
247
|
Suporta middlewares Express.
|
|
248
248
|
|
|
249
|
-
|
|
249
|
+
**Por que é melhor que Express puro:**
|
|
250
250
|
|
|
251
251
|
Sem boilerplate: não precisa chamar `app.get(...)` ou `app.post(...)` manualmente.
|
|
252
252
|
|
|
@@ -257,7 +257,7 @@ Auto-descoberta de rotas: Fastay detecta automaticamente os arquivos de rota e r
|
|
|
257
257
|
Fácil manutenção de projetos grandes: sem necessidade de registrar manualmente centenas de rotas, mantendo organização clara.
|
|
258
258
|
|
|
259
259
|
|
|
260
|
-
1
|
|
260
|
+
**1. Express.js**
|
|
261
261
|
|
|
262
262
|
```bash
|
|
263
263
|
import express from 'express';
|
|
@@ -295,7 +295,7 @@ Escalabilidade de grandes projetos fica complicada.
|
|
|
295
295
|
|
|
296
296
|
---
|
|
297
297
|
|
|
298
|
-
2
|
|
298
|
+
**2. NestJS**
|
|
299
299
|
|
|
300
300
|
```bash
|
|
301
301
|
import { Controller, Get, Post, Body } from '@nestjs/common';
|
|
@@ -314,7 +314,7 @@ export class HelloController {
|
|
|
314
314
|
}
|
|
315
315
|
```
|
|
316
316
|
|
|
317
|
-
Características do NestJS
|
|
317
|
+
**Características do NestJS:**
|
|
318
318
|
|
|
319
319
|
Baseado em decorators e classes.
|
|
320
320
|
|
|
@@ -328,7 +328,7 @@ Exige aprendizado de decorators, módulos e injeção de dependências.
|
|
|
328
328
|
|
|
329
329
|
---
|
|
330
330
|
|
|
331
|
-
3
|
|
331
|
+
**3. Fastay.js**
|
|
332
332
|
|
|
333
333
|
```bash
|
|
334
334
|
import { Request } from '@syntay/fastay';
|
|
@@ -344,7 +344,7 @@ export async function POST(req: Request) {
|
|
|
344
344
|
}
|
|
345
345
|
```
|
|
346
346
|
|
|
347
|
-
Características do Fastay
|
|
347
|
+
**Características do Fastay:**
|
|
348
348
|
|
|
349
349
|
Baseado em arquivos, cada método HTTP é exportado.
|
|
350
350
|
|
|
@@ -365,7 +365,7 @@ Tipo-safe, clean e simples.
|
|
|
365
365
|
|
|
366
366
|
---
|
|
367
367
|
|
|
368
|
-
Middlewares
|
|
368
|
+
**Middlewares**
|
|
369
369
|
|
|
370
370
|
Fastay permite middlewares auto-carregados e via createMiddleware:
|
|
371
371
|
|
|
@@ -378,7 +378,7 @@ export async function auth(req: Request, _res: Response, next: Next) {
|
|
|
378
378
|
}
|
|
379
379
|
```
|
|
380
380
|
|
|
381
|
-
E crie um arquivo middleware.ts dentro da pasta src/middleware e use a função createMiddleware para configurar o seu middleware:
|
|
381
|
+
E crie um arquivo middleware.ts dentro da pasta `src/middleware` e use a função createMiddleware para configurar o seu middleware:
|
|
382
382
|
|
|
383
383
|
```bash
|
|
384
384
|
import { createMiddleware } from '@syntay/fastay';
|
|
@@ -393,14 +393,14 @@ export const middleware = createMiddleware({
|
|
|
393
393
|
|
|
394
394
|
---
|
|
395
395
|
|
|
396
|
-
|
|
396
|
+
**Fluxo de Request**
|
|
397
397
|
|
|
398
|
-
Cliente → Rota Fastay → Middleware → Handler da Rota → Service → Response
|
|
398
|
+
*Cliente → Rota Fastay → Middleware → Handler da Rota → Service → Response*
|
|
399
399
|
|
|
400
400
|
|
|
401
401
|
---
|
|
402
402
|
|
|
403
|
-
Conclusão
|
|
403
|
+
**Conclusão**
|
|
404
404
|
|
|
405
405
|
Fastay.js é um framework backend leve e TypeScript-first que:
|
|
406
406
|
|