narutoapi / README.md
GalvaoFilho's picture
Upload 4 files
2652b5e verified
---
title: Naruto API
emoji: 🍥
colorFrom: red
colorTo: yellow
sdk: docker
app_port: 7860
---
# Naruto API
API didática desenvolvida com FastAPI para consulta de dados do universo Naruto.
## Endpoints principais
- `/` — Página inicial.
- `/docs` — Documentação automática da API.
- `/anime` — Informações gerais sobre o anime.
- `/personagens` — Lista todos os personagens.
- `/personagens/{id}` — Busca personagem pelo ID.
- `/buscar?q=naruto` — Busca personagem pelo nome.
- `/clas` — Lista os clãs cadastrados.
- `/clas/{cla}` — Busca personagens por clã.
- `/vilas` — Lista as vilas cadastradas.
- `/vilas/{vila}` — Busca personagens por vila.
- `/ranking-poder` — Ranking por nível de poder.
- `/estatisticas` — Estatísticas gerais.
## Como executar localmente
Instale as dependências:
```bash
pip install -r requirements.txt
```
Execute a API:
```bash
uvicorn app:app --reload
```
Acesse:
```text
http://127.0.0.1:8000
```
Documentação automática:
```text
http://127.0.0.1:8000/docs
```
## Como publicar no Hugging Face Spaces
1. Crie um novo Space no Hugging Face.
2. Escolha o SDK Docker.
3. Envie todos os arquivos deste projeto.
4. Aguarde o build finalizar.
5. Acesse `/docs` no endereço público do Space.
## Sobre as imagens
As imagens dos personagens devem ser colocadas na pasta:
```text
static/imagens/
```
Os nomes esperados no JSON são:
- `naruto.jpg`
- `sasuke.jpg`
- `sakura.jpg`
- `kakashi.jpg`
- `hinata.jpg`
- `jiraiya.jpg`
- `tsunade.jpg`
- `gaara.jpg`
- `itachi.jpg`
- `orochimaru.jpg`
Por questões de direitos autorais, este projeto vem com arquivos de instrução no lugar das imagens reais. Substitua os arquivos pela imagem correspondente, mantendo exatamente o mesmo nome.