https://github.com/flkt-crnpio/fastapi-sandbox
Pruebas para crear la documentacion de una API bajo los protocolos de OpenAPI utilizando el framework de FastAPI
https://github.com/flkt-crnpio/fastapi-sandbox
fastapi openapi python python3
Last synced: about 1 month ago
JSON representation
Pruebas para crear la documentacion de una API bajo los protocolos de OpenAPI utilizando el framework de FastAPI
- Host: GitHub
- URL: https://github.com/flkt-crnpio/fastapi-sandbox
- Owner: flkt-crnpio
- Created: 2020-11-12T22:45:21.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-04-21T20:47:33.000Z (about 5 years ago)
- Last Synced: 2025-01-22T18:33:02.684Z (over 1 year ago)
- Topics: fastapi, openapi, python, python3
- Language: Python
- Homepage:
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FastAPI sandbox
Pruebas para crear la documentacion de una API bajo los protocolos de [OpenAPI](https://www.openapis.org/) utilizando el framework de [FastAPI](https://fastapi.tiangolo.com/)
## requerimientos
[python](https://www.python.org/)
[pip](https://pypi.org/project/pip/)
## instalación
Clona el repositorio y entra en la carpeta en la que lo clonaste.
```
git clone git@github.com:flkt-crnpio/fastapi-sandbox.git
cd fastapi-sandbox/
```
Crea tu entorno virtual e instala los requerimientos. Este ejemplo crea el entorno con virtualenv
```
python3 -m pip install virtualenv
python3 -m virtualenv env
source env/bin/activate
pip install -r requirements.txt
```
## prueba entorno local
Para correr la API
```
uvicorn main:app --reload
```
La documentación que se genera de la API se puede ver en localhost
```
http://127.0.0.1:8000/nombredelaurl
```