python rest api

Uma API de descanso simples por Python

Eu construo uma API de descanso muito básica com Python.

Como usar?

Você pode usá -lo no VirtualEnv ou Docker.

Se você deseja usar o VirtualEnv. Siga as instruções abaixo

Método Virtualenv

1. Crie seu virtualEnv e ative seu virtualenv instalar todas as libs do requisitos.txt por comando abaixo

pip install -r requirements.txt 

2. Agora crie o arquivo .env em seu diretório raiz e adicione texto ou strings abaixo

 ALLOWED_HOSTS=*,127.0.0.1,
DATABASE_NAME=<your database name>
DATABASE_USERNAME=<your database username>
DATABASE_PASSWORD=<your datababse password>
DATABASE_HOST=<your database host>
DATABASE_PORT=5432

[NB: você precisa instalar o banco de dados PostGresql em sua máquina, caso contrário, não poderá usar este projeto.]

3. Após a configuração do DB, você precisa executar o comando abaixo para criar tabelas no seu banco de dados.

python db_table_creation.py

Não se esqueça de ativar seu virtualenv e também este comando funcionará no diretório raiz do seu projeto.

[NB Atualmente, eu estava usando o SQL bruto para criar dados de tabela, consulta a partir do banco de dados. No futuro, planejei mover uma maneira mais pitônica, fazer modelo, migração e também implementarei o ORM]

4. O projeto atual possui URLs estáticos. O IE atualmente URL Patten não é prefeito. Abaixo os URLs estão disponíveis apenas

Receitas

Nome	Método	Url	Protegido
Lista	GET	/recipes	✘
Criar	POST	/recipes	✓
Pegar	GET	/recipes/{id}	✘
Atualizar	PUT/PATCH	/recipes/{id}	✓
Excluir	DELETE	/recipes/{id}	✓
Avaliar	POST	/recipes/{id}/rating	✘

5. Para acessar URLs protegidos, você precisa usar a autenticação básica em seu cliente (por exemplo, Postman) e usar credenciais abaixo

 username: vubon
password: 123456

Se você quiser mudar. Vá para a pasta dos servidores e abra o arquivo default_user.py. Encontre ususer_data Função final do arquivo e altere o nome de usuário e a senha também

6. Isso é tudo .

Método Docker

1. Instale o docker em sua máquina. Minha versão do Docker foi 18.06.0-CE e Docker Compuse Versão 1.22.0

2. Use a mesma versão Docker e Docker Compose. A menos que a configuração do arquivo docker-compose.yml talvez seja incompatível

3. Siga a Etapa 2 do Método VirtualEnv. Agora abra o arquivo docker-compose.yml e vá para a seção Postgres. Use este nome de banco de dados, nome de usuário do banco de dados, senha de banco de dados no seu arquivo .env. Lembre -se de que seu host de banco de dados é PostGres .

4. Depois de fazer a etapa 3. Execute o comando abaixo

[sudo] docker-compose up --build 

5. Só você precisa construir pela primeira vez, a menos que não precise.

[sudo] docker-compose up

[NB Lembre-se de que você muda alguma coisa no arquivo Docker-Compose ou Dockerfile, você precisa construir e também se adicionar novas libs em seu projeto] 6. Siga a Etapa 4 do VirtualEnv para acessar os URLs 7.

Créditos **

Eu adotei muitas filosofias do Django neste projeto.

Obrigado Django Team

Codificação feliz