Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorviniciussantana/blog-api
Backend para meu blog utilizando Fastify e Prisma.
https://github.com/igorviniciussantana/blog-api
api blog fastify prisma typescript
Last synced: 4 days ago
JSON representation
Backend para meu blog utilizando Fastify e Prisma.
- Host: GitHub
- URL: https://github.com/igorviniciussantana/blog-api
- Owner: igorviniciussantana
- Created: 2023-02-17T14:35:21.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-10T22:39:24.000Z (almost 2 years ago)
- Last Synced: 2024-11-19T02:57:57.305Z (2 months ago)
- Topics: api, blog, fastify, prisma, typescript
- Language: TypeScript
- Homepage:
- Size: 145 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
iBlog - API
Esse projeto consiste na API desenvolvida para uma aplicação de blog construída com Fastify e Prisma, utilizando o TypeScript como linguagem.
🏗️ | Funcionalidades Incluídas
- Criptografia de Senhas
- Autenticação com JWT
- CRUD das entidades de Usuário, Post e Categoria.
- Casos de Uso para favoritar posts.
🛠 | Bibliotecas e Tecnologias Utilizadas
- NodeJS
- TypeScript
- Fastify
- PrismaORM
- Zod
- JSON Web Token
- CryptoTS
✔ | Requisitos
- Editor de Códigos
- NodeJS
- Git
- Ferramenta para testes de API(como Postman, Insomnia)
🖥 | Rodando Localmente
### Instalação
```bash
$ npm install
```
### Configurando o Banco
Crie o arquivo `.env` e insira os dados
```bash
DATABASE_URL=
```
### Migrando o Banco
```bash
npx prisma migrate dev
```
### Excutando o projeto
```bash
$ npm run dev
```
🛣️ | Endpoints
Posts
Entidade
Rota
Parâmetros
Método
Retorno
POST
/posts
Nenhum
GET
Retorna todos os posts cadastrados.
POST
/posts
Nenhum
POST
Criação de um Post.
POST
/posts/:id
ID do Post
GET
Retorna um post de acordo com seu ID.
POST
/posts/:id
ID do Post
PUT
Atualiza o Post através do seu ID.
POST
/posts/:id
ID do Post
DELETE
Deleta o Post através do seu ID.
Auth
Entidade
Rota
Parâmetros
Método
Retorno
AUTH
/me
Nenhum
GET
Retorna os dados do usuário autenticado.
AUTH
/signin
Nenhum
POST
Autentica o usuário.
Categorias
Entidade
Rota
Parâmetros
Método
Retorno
CATEGORIA
/categories
Nenhum
GET
Retorna todas as categorias.
CATEGORIA
/categories/:name
Nome da Categoria
GET
Retorna uma categoria por nome.
CATEGORIA
/categories
Nenhum
POST
Cria uma nova categoria.
## 👤 | Autor
