API REST em Python

Este projeto é uma REST API que atende aos chamados HTTP, retorna um JSON com a Competição criada, a criar ou a ser encerrada.

De um a dois parágrafos sobre o que é seu projeto e o que ele faz

Esta RestAPI quer tornar o COR (Comitê Olímpico Radar), um evento benéfico para todos, captando as competições e resultados dos atletlas de forma rápida e eficiente. O benefício de utilizar a API, é que você não precisará ficar esperando a competição se encerrar para ficar sabendo dos resultados, você poderá saber o resultado parcial também, para acompanhar um atleta, ou saber como anda uma competição.

Instalação do Ambiente Virtual

OS X & Linux & Windows:

python -m venv radar

Instalação das Dependências

OS X & Linux & Windows:

pip install -r requirements.txt

Ativação do Ambiente Virtual

OS X & Linux & Windows PowerShell:

.\radar\Scripts\activate.sp1

Windows cmd:

.\radar\Scripts\activate.bat

Exemplo de utilização da API

Comando HTTP para buscar todas as competições:

GET '../api/competicao';

Comando HTTP para buscar {x} competição:

GET '../api/competicao/{x}';

Ambiente para Teste de methods

Para se testar a api e os methods (GET,POST,PUT,DELETE), foi criado uma documentação swagger.json, para que seja possível testes e validação de API, que pode ser acessado em:

'../api/doc';

Lá se encontra essa seguinte interface:

Assim pode-se testar a API da seguinte forma:

Dê um click na ação desejada (GET,POST,PUT,DELETE), logo após clique no botão: "Try it out" e deverá abrir o método desejado com os VALORES EDITÁVEIS:

Após fazer suas alterações, note que, o payload é requirido, ou seja, todos os atributos são obrigatórios(PS: CAMPO Enc é para saber se a competição está em andamento ou foi encerrada, 0 para em andamento, 1 para encerrada). E é só clicar em EXECUTE:

Contato

Lucas de Souza Duarte – [email protected]

GitHub - (https://github.com/duartegit)