Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

75 lines (46 loc) · 2.5 KB

API-Pokemon 🚀

A API-Pokemon é um projeto exemplar desenvolvido com fins educacionais, com o propósito de ilustrar a implementação prática do framework Next.js para aplicativos de backend. Este projeto foi concebido como parte integrante de um curso universitário sobre desenvolvimento de backend, com a principal meta de aprimorar habilidades técnicas e proporcionar um entendimento mais profundo das práticas de desenvolvimento ágil.

Este projeto exemplifica a aplicação real das tecnologias estudadas e serve como um guia esclarecedor para estudantes e desenvolvedores que desejam compreender como criar soluções de backend eficazes. É uma demonstração prática e esclarecedora de como os conceitos teóricos se traduzem em soluções de software funcionais.

Exemplo acesse o projeto nas rotas

Visão Geral

A API-Pokemon fornece três rotas distintas, cada uma com funcionalidades:

1. GET /api/get-all

  • Descrição: Esta rota permite buscar todos os dados fornecidos pela API
  • Uso: GET /api/get-all

2. GET /api/get-one

  • Descrição: Esta rota permite recuperar dados especificando um ID.
  • Uso: GET /api/get-one

3. GET /api/sort?id=<set_int>

  • Descrição: Esta rota permite realizar uma ordenação aleatória e recuperar os dados na posição especificada.
  • Uso: GET /api/sort?id=5

Começando

Para começar a usar esta API, siga estas etapas:

  1. Clone o repositório para sua máquina local:
  git clone https://github.com/marco0antonio0/api-pokemons
  1. Instale as dependências necessárias:
  npm install
  1. Inicie o servidor:
  npm run dev
  1. Acesse a API por meio das rotas definidas, conforme descrito na seção "Visão Geral".

Contribuições

Recebemos contribuições da comunidade para aprimorar e expandir este projeto educacional. Sinta-se à vontade para enviar problemas (issues) ou solicitações de pull (pull requests) para ajudar a melhorar a API-Pokremon.

Licença

Este projeto está licenciado sob a Licença MIT.

Contato

Se você tiver alguma dúvida ou precisar de assistência adicional, não hesite em entrar em contato conosco.

  • Marco Antonio
  • Universidade unama
  • Ciencias da computação - disciplina back - end

🚀🚀🚀