Git Product home page Git Product logo

express-rest-api's Introduction

Melhores práticas para projetar APIs REST

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.

Descrição

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.

Tópicos abordados

  • 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

Implementação

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.

Pré-requisitos

  • 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

Tutorial

O tutorial do freeCodeCamp também está disponível em: https://www.freecodecamp.org/news/rest-api-design-best-practices-build-a-rest-api/

express-rest-api's People

Contributors

davijust avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.