juan.ley54@unach.mx afc7aa99c0 Readme fixed
2026-02-07 02:05:48 -06:00
2026-02-07 02:05:48 -06:00

I was too lazy to write this in a markdown file. And lazy enough to write this in English as well.
------------------------------------------------

Welp. Easy RESTful API and stuff.

Endpoints:
- GET           | /             | Sample root endpoint.
- GET           | /docs         | Swagger UI for testing the endpoints.
- GET           | /users        | List all users.
- GET           | /users/{id}   | Gets a user by its id in database.
- POST          | /users        | Adds a new user to the database.

Dependencies JIC you want to make your own virtual python environment:
- uvicorn       | To run API apps
- fastapi       | This project's API Framework
- pydantic      | Data validation library
- sqlalchemy    | Framework to operate databases with abstractions

Extra implementations:
- Database      | SQLite3 Database file. /src/users.db
- Windows & UNIX| For Windows or Linux servers, this API includes both .env directories for windows and UNIX. /.env & /.env-unix

Tested on:
- Windows
- Linux (WSL & Native) - Using Arch Linux.

Not tested on:
- BSD - FreeBSD and/or NetBSD.
- Docker.
- Micropython - ESP32.
- Other Python compatible systems.
Description
FastAPI implementation for microservices with Hexagonal architectute
Readme 15 MiB
Languages
Python 99.3%
Shell 0.7%