Skip to content

Simples API REST desenvolvida em python com o uso do framework Django, usando um exemplo fictício de uma escola.

Notifications You must be signed in to change notification settings

Rodrigoaz7/school-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

school-api

Simples API REST desenvolvida em python com o uso do framework Django, usando um exemplo fictício de uma escola. Alguns dos itens utilizados no projeto:

  • Python
  • Django/Django Rest
  • PostgreSQL
  • Docker

Instalação

Primeiramente, você deve ter instalado o python(3>=) no seu computador, além do gerenciador de pacotes pip. Com os dois devidamente instalados, ainda é necessário instalar libs relacionadas ao Docker, caso ainda não as possua:

Featurings do projeto:

Rodando Projeto

Com todas as features instaladas e o repositório clonado, basta ir até a raiz do projeto e executar os comandos:

  • Iniciar nova máquina docker dev docker-machine create -d virtualbox dev
  • Configurar shell para usar nova máquina dcoker eval $(docker-machine env dev)
  • Build imagens docker-compose build
  • Capturar IP de dev para visualização docker-machine ip dev
  • Iniciar services docker-compose up

Se tudo ocorrer bem, basta apenas usar o IP de dev capturado no passo anterior e poderá ter acesso a API com:

  http://<IP_dev>:8000

API

Para ter acesso a toda informação necessária sobre a API, basta apenas ver a documentação gerada pelo swagger, pelas seguintes rotas:

  http://<IP_dev>:8000/swagger
  ou
  http://<IP_dev>:8000/redoc

About

Simples API REST desenvolvida em python com o uso do framework Django, usando um exemplo fictício de uma escola.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published