{"id":19499769,"url":"https://github.com/apsl/pycon-fastapi-example","last_synced_at":"2025-04-25T22:34:30.908Z","repository":{"id":196538960,"uuid":"696329265","full_name":"APSL/pycon-fastapi-example","owner":"APSL","description":null,"archived":false,"fork":false,"pushed_at":"2023-10-02T05:57:46.000Z","size":37,"stargazers_count":3,"open_issues_count":0,"forks_count":9,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-04-15T00:26:46.969Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/APSL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-25T14:33:46.000Z","updated_at":"2023-10-06T17:24:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"75bbee07-32cb-4f34-9f35-6d6ea818b98b","html_url":"https://github.com/APSL/pycon-fastapi-example","commit_stats":null,"previous_names":["apsl/pycon-fastapi-example"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APSL%2Fpycon-fastapi-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APSL%2Fpycon-fastapi-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APSL%2Fpycon-fastapi-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/APSL%2Fpycon-fastapi-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/APSL","download_url":"https://codeload.github.com/APSL/pycon-fastapi-example/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224019605,"owners_count":17242177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T22:06:15.479Z","updated_at":"2024-11-10T22:06:16.150Z","avatar_url":"https://github.com/APSL.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Guía paso a paso\n\n## 6. Versionado y obsolescencia de endpoints\n\n* Editar modelo para las pruebas.\n* Generar un nuevo endpoint.\n* Instalación de fastapi-versioning.\n* Agregar versionado en main.py\n* Generar la versión superior del endpoint anterior y marcar como deprecado el anterior.\n\n\n## 5. Añadir logs a nuestra API\n\n* Definir ruta del fichero de configuración de los logs en el settings.\n* Añadir carga de la configuración de logs en main.py.\n* Usar los logs importando `logging` y registrar de la mejor manera posible toda invocación a nuestros endpoints.\n\n\n## 4. Agrupar el código y leer constantes de settings\n\n* Instalación de pydantic-settings para las constantes del proyecto\n* Mover a models/ los modelos\n* Mover a routers/ los endpoints y agruparlos por tipo\n* Generar settings para las constantes del proyecto\n* Crear .env y .secrets para las constantes públicas y privadas\n* Adaptar código en main.py\n* Nuevo comando para ejecutar el proyecto: `python src/run.py`\n\n\n## 3. Añadir validadores de esquemas y ORM\n\n* Instalación de beanie (ODM [object-document mapper] basado en pydantic).\n* Crear modelos para la validación de request y response de los endpoints.\n* Actualizar endpoints con los modelos.\n* Eliminar get_db, no será necesario gracias a beanie. \n\n\n## 2. Añadir endpoint con accesos a base de datos\n\n* Instalación de \"motor\" (driver para conexiones a mongo de manera asíncrona).\n* Creación de los endpoints GET /posts y POST /posts\n* Creación de una instancia del driver, mongo_db.\n* Creación una función para inyectar el driver a base de datos en cada endpoint.\n* Añadir dos eventos a la API, que mantendrá el cliente de mongo abierto y tras morir el servidor matará el cliente.\n* Probar en http://localhost:8000/docs\n\n\n## 1. Creación servidor mínimo\n\nRealizar la instalación de dependencias\n\n```bash\npip install -r requirements.txt\n```\n\nEjecutar servidor\n\n```bash\nuvicorn src.main:app --reload\n```\n\nProbar endpoints\n\n* http://localhost:8000/ping\n* http://localhost:8000/docs\n* http://localhost:8000/static/image-unavailable.png\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapsl%2Fpycon-fastapi-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapsl%2Fpycon-fastapi-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapsl%2Fpycon-fastapi-example/lists"}