Skip to content

isaias0rt0n/school-api

Repository files navigation

📖 School API

Simples API para cadastro de cursos e avaliação de cursos.

🔗Referência

🔨 Instalação

Instale school-api com docker

  git clone https://github.com/isaias0rt0n/school-api.git
  cd school-api
  docker-compose up

Rodando as migrations

  docker-compose exec app python manage.py makemigrations
  docker-compose exec app python manage.py migrate

Rodando os testes

Para rodar os testes, rode o seguinte comando

  • Lembrando de configurar no settings.py a autenticação para TokenAuthentication
  python test_pytest.py

⚙️Deploy

Deploy do Projeto na AWS/Azure

Coming soon!

🏷️Documentação

http://localhost:8000/docs

Obter Token de Acesso

Cadastrar um usuário

  POST http://localhost:8000/api/users/

Exemplo

curl --request POST \
--url http://localhost:8000/api/users/ \
--header 'Content-Type: application/json' \
--data '{
"username": "user_1",
"password": "123456789"
}'

Resposta

{
  "username": "user_1"
}

Geração de Token

Campos: grant_type, client_id, client_secret, username, password, scope

curl -X POST \
--data '{"grant_type": "password", "client_id": "", "client_secret": "", "username": "", "password": <>, "scope": "write"}' \
> --header 'Content-Type: application/json' \
> --url http://localhost:8000/o/token/

Resposta

{
	"access_token": "6gMqKXWD9n0JX9r7WQ4GI955CBw14A",
	"expires_in": 36000,
	"token_type": "Bearer",
	"scope": "write",
	"refresh_token": "QUoIDI2HqTh0Zge3OK0rbNR7SoohBC"
}

Autores

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published