Blog API Interview

Uma API simples para um blog, desenvolvido com a finalidade de entrevista para desenvolvedor back-end.

Documentação da API

Todas as requisições serão prefixadas com o seguinte endereço: http://localhost:3333/api/.

Deploy da API

Foi realizado o deploy da api no heroku com o seguinte endereço: https://api-blog-interview.herokuapp.com/api/.

Swagger

Os recursos disponiveis podem ser visualizadas no seguinte endereço: http://localhost:3333/api/swagger.

Posts

Operações relacionados aos posts do blog.

Descrição	Verbo	Endereço	Body
Listar todos os posts	GET	/posts
Cadastrar um post	POST	/posts	{ title: String, description: String, author: String, categories: String }
Buscar um post	GET	/posts/{postId}
Alterar um post	PUT	/posts/{postId}	{ title: String, description: String, author: String, categories: String }
Deletar um post	PUT	/posts/{postId}

Tecnologias Utilizadas

O projeto foi desenvolvido utilizando as seguintes tecnologias

• TypeScript
• Node.js
• Nest.JS
• Heroku

Instalação

$ npm install

Executando o projeto

# local
$ npm run start

# watch mode
$ npm run start:dev

# produção
$ npm run start:prod

Executando os testes

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Funcionalidades futuras

• Configuração de um banco de dados (Postgres)
• Autenticação para gerenciar os posts do blog.
• Soft delete nos posts
• Data de publicação dos posts
• Filtros na listagem de posts (author, title, categoria e etc.)

Como contribuir

• Faça um Fork desse repositório,
• Crie uma branch com a sua feature: git checkout -b my-feature
• Commit suas mudanças: git commit -m 'feat: My new feature'
• Push a sua branch: git push origin my-feature

License

Esse projeto está sob a licença MIT. Veja o arquivo MIT licensed para mais detalhes.

---

Feito com 💜 by John Victor