Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skrodrigo/notify-backend-nodejs
Esta é uma API para gerenciar notícias, permitindo criar, listar, atualizar e deletar notícias. Usando Fastify e Prisma
https://github.com/skrodrigo/notify-backend-nodejs
api-crud clean-architecture fastify layered-architecture mvc-architecture prisma typescript
Last synced: about 2 months ago
JSON representation
Esta é uma API para gerenciar notícias, permitindo criar, listar, atualizar e deletar notícias. Usando Fastify e Prisma
- Host: GitHub
- URL: https://github.com/skrodrigo/notify-backend-nodejs
- Owner: skrodrigo
- Created: 2024-09-26T23:54:10.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-31T15:03:38.000Z (about 2 months ago)
- Last Synced: 2024-10-31T16:19:02.039Z (about 2 months ago)
- Topics: api-crud, clean-architecture, fastify, layered-architecture, mvc-architecture, prisma, typescript
- Language: TypeScript
- Homepage:
- Size: 10.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# News CRUD API
Esta é uma API para gerenciar notícias, permitindo criar, listar, atualizar e deletar notícias.
## Tecnologias Utilizadas
- Node.js
- Fastify
- Prisma
- PostgreSQL
## Instalação
1. Clone o repositório:
```bash
git clone https://github.com/skrodrigo/news.crud.api.git
cd news.crud.api
```
2. Instale as dependências:
```bash
npm install
```
3. Configure o banco de dados no arquivo `.env`:
```bash
DATABASE_URL=postgresql://USER:PASSWORD@localhost:5432/newsAPI
```
4. Execute as migrações do Prisma:
```bash
npx prisma migrate dev
```
5. Inicie o servidor:
```bash
npm run dev
```
## Endpoints
- `GET /news`: Listar todas as notícias
- `GET /news/:id`: Obter uma notícia por ID
- `POST /news`: Criar uma nova notícia
- `PUT /news/:id`: Atualizar uma notícia existente
- `DELETE /news/:id`: Deletar uma notícia por ID
## Contribuição
Sinta-se à vontade para abrir issues ou pull requests.
## Swagger Documentation
The current swagger.yml needs updates to include:
- Authentication endpoints
- Security schemes
- Request/Response examples
Here's a partial fix for the security scheme:
```yaml
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
security:
- bearerAuth: []
```