Este repositório implementa o tutorial "REST API Design Best Practices - Build a REST API with JavaScript, Node.js, and Express.js" de freeCodeCamp. O tutorial ensina as melhores práticas para criar uma API REST robusta usando Node.js e Express.js.
A API de exemplo é construída para um aplicativo de treinamento CrossFit. Os usuários (proprietários de academia) podem criar, ler, atualizar e excluir treinos do dia (WODs) e adicionar dicas de treinamento importantes para cada treino.
- Versionamento de API
- Nomear recursos no plural
- Aceitar e responder com dados em formato JSON
- Responder com códigos de status HTTP padrão
- Evitar verbos nos nomes dos endpoints
- Agrupar recursos associados
- Integrar filtragem, ordenação e paginação
- Usar cache de dados para melhorar o desempenho
- Boas práticas de segurança
- Documentar sua API adequadamente
Este repositório fornece uma implementação prática das orientações fornecidas no tutorial do freeCodeCamp para projetar e desenvolver APIs REST robustas. Embora a API de exemplo seja escrita em JavaScript e Express, as melhores práticas não se limitam a essas ferramentas e podem ser aplicadas a outras linguagens de programação e frameworks.
- Experiência com JavaScript, Node.js e Express.js
- Conhecimento de arquitetura backend e conceitos como REST e APIs
- Familiaridade com o modelo cliente-servidor
O tutorial do freeCodeCamp também está disponível em: https://www.freecodecamp.org/news/rest-api-design-best-practices-build-a-rest-api/