Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thepabloaguilar/star-wars-planets-api
https://github.com/thepabloaguilar/star-wars-planets-api
Last synced: about 9 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/thepabloaguilar/star-wars-planets-api
- Owner: thepabloaguilar
- Created: 2019-07-07T19:00:34.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T05:51:26.000Z (almost 2 years ago)
- Last Synced: 2023-09-25T03:32:45.166Z (about 1 year ago)
- Language: Python
- Size: 125 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Star Wars Planets - API
O intuito desta API é gerenciar os planetas para a franquia de filmes [Star Wars](https://www.starwars.com).
### Tecnologias Utilizadas
* [**Python**](https://www.python.org)
* [**Sanic**](https://sanic.readthedocs.io/en/latest/)
* [**Sanic Restful**](https://github.com/CoCongV/sanic-restful)
* [**Sanic Motor**](https://github.com/lixxu/sanic-motor)
* [**Sanic Cors**](https://github.com/ashleysommer/sanic-cors)
* [**Marshmallow**](https://marshmallow.readthedocs.io/en/3.0/index.html)
* [**Marshmallow Dataclass**](https://lovasoa.github.io/marshmallow_dataclass/html/marshmallow_dataclass.html)
* [**aiohttp**](https://aiohttp.readthedocs.io/en/stable/)
* [**MongoDB**](https://www.mongodb.com)
* [**Docker**](https://www.docker.com)
* [**Docker Compose**](https://docs.docker.com/compose/)
* [**Swagger UI**](https://swagger.io/tools/swagger-ui/)
### Rodando a aplicação
#### Requisitos
* Docker
* Docker Compose
Para rodar a aplicação basta executar o comando:
```sh
make go
```
Depois de tudo *startado* os Endpoints ficarão disponivel em:
* Aplicação: [localhost:6606](http://0.0.0.0:6606)
* Documentação: [localhost:6607](http://0.0.0.0:6607)
A interação com a API pode ser feita por meio da documentação, onde será exibida uma tela como a abaixo, onde você poderá ver as repostas dos Endpoints bem como os parâmetros que podem ser passados:
