Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marco0antonio0/api-pokemons
Este repositorio é uma api feita em next js para consultas de pokemons e assim use na sua aplicação web ou mobile
https://github.com/marco0antonio0/api-pokemons
api backend collaborate javascript nextjs
Last synced: about 1 month ago
JSON representation
Este repositorio é uma api feita em next js para consultas de pokemons e assim use na sua aplicação web ou mobile
- Host: GitHub
- URL: https://github.com/marco0antonio0/api-pokemons
- Owner: marco0antonio0
- License: mit
- Created: 2023-09-28T21:15:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-21T16:00:56.000Z (about 1 year ago)
- Last Synced: 2024-10-13T04:26:51.654Z (2 months ago)
- Topics: api, backend, collaborate, javascript, nextjs
- Language: JavaScript
- Homepage:
- Size: 171 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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
- busca os dados do pokemon por **id**
- https://api-pokemon.nova-work.cloud/api/get-one?id=5
- busca os todos os dados de **todos** os pokemons
- https://api-pokemon.nova-work.cloud/api/get-all
- sortea **apenas um** pokemon
- https://api-pokemon.nova-work.cloud/api/sort
## 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`
- Descrição: Esta rota permite realizar uma ordenação aleatória e recuperar os dados do item sorteado.
- Uso: `GET /api/sort`
## Começando
Para começar a usar esta API, siga estas etapas:
1. Clone o repositório para sua máquina local:
```bash
git clone https://github.com/marco0antonio0/api-pokemons
```
2. Instale as dependências necessárias:
```bash
npm install
```
3. Inicie o servidor:
```bash
npm run dev
```
4. 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](LICENSE.md).
## 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
## Colaboradores 🚀🚀🚀
- Desenvolvedor
- [@Marco antonio](https://github.com/marco0antonio0)
- Documentação
- [@Jean Dias](https://github.com/JeanArthurCostaDias)
- [@Alexsandro Fernandes](https://github.com/AlexsandroFernandesNascimento)
- @Bea