python rest api

Una simple API de descanso de Python

Construyo una API REST muy básica con Python.

¿Cómo usar?

Puede usarlo en VirtualEnv o Docker.

Si quieres usar VirtualEnv. Sigue las instrucciones a continuación

Método VirtualEnv

1. Cree su virtualenv y active su virtualenv instalar todas las libs de requisitos.txt por el siguiente comando

pip install -r requirements.txt 

2. Ahora cree el archivo .env en su directorio raíz y agregue texto o cadenas a continuación

 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: necesita instalar la base de datos PostgreSQL en su máquina, de lo contrario no puede usar este proyecto.]

3. Después de la configuración de DB, debe ejecutar el siguiente comando para crear tablas en su DB.

python db_table_creation.py

No olvide activar su VirtualEnv y también este comando funcionará en su directorio raíz del proyecto.

[NB actualmente estaba usando SQL sin procesar para crear datos de tabla, consulta de DB. En el futuro tengo planes de mover más camino pitónico, haciendo modelo, migración y también implementaré ORM]

4. El proyecto actual tiene URL estáticas. IE Actualmente URL Patten no es prefecto. Por debajo de las URL están disponibles solo

Recetas

Nombre	Método	Url	Protegido
Lista	GET	/recipes	✘
Crear	POST	/recipes	✓
Conseguir	GET	/recipes/{id}	✘
Actualizar	PUT/PATCH	/recipes/{id}	✓
Borrar	DELETE	/recipes/{id}	✓
Tasa	POST	/recipes/{id}/rating	✘

5. Para acceder a URL protegidas, debe usar la autenticación básica en su cliente (por ejemplo, Postman) y usar credenciales a continuación

 username: vubon
password: 123456

Si quieres cambiar. Vaya a la carpeta de servidores y abra el archivo default_user.py. Encuentre la función ususer_data final del archivo y cambie el nombre de usuario y la contraseña también

6. Eso es todo.

Método Docker

1. Instale Docker en su máquina. Mi versión de Docker fue 18.06.0-CE y Docker Compose Versión 1.22.0

2. Use la misma versión Docker y Docker Compose. A menos que la configuración del archivo Docker-Compose.yml quizás sea desalentador

3. Siga el paso 2 del método VirtualEnv. Ahora abra el archivo Docker-compose.yml y vaya a la sección Postgres. Use este nombre de DB, nombre de usuario de DB, contraseña de DB en su archivo .env. Recuerde que el host de su base de datos es Postgres .

4. Una vez que hayas hecho el paso 3. Ejecute el comando Bellow

[sudo] docker-compose up --build 

5. Solo usted necesita construir la primera vez a menos que no lo necesite.

[sudo] docker-compose up

[NB Recuerde que si cambia algo en el archivo Docker-Compose o Dockerfile que necesita construir y también si agrega nuevas libs en su proyecto] 6. Siga el paso 4 de VirtualEnv para acceder a URLS 7. Si desea cambiar el nombre de usuario y la contraseña, siga el paso 5 del método VirtualEnv

Créditos **

Adopté muchas filosofías forman django en este proyecto.

Gracias equipo de Django

Codificación feliz