mirror of
https://github.com/wowlikon/LibraryAPI.git
synced 2025-12-11 21:30:46 +00:00
101 lines
3.5 KiB
Markdown
101 lines
3.5 KiB
Markdown
# Book API
|
|
|
|
This project is a test web application built using FastAPI, a modern web framework for creating APIs in Python. It showcases the use of Pydantic for data validation, SQLModel for database interactions, Alembic for migration management, PostgreSQL as the database system, and Docker Compose for easy deployment.
|
|
|
|
### **Key Components:**
|
|
|
|
1. FastAPI: Provides high performance and simplicity for developing RESTful APIs, supporting asynchronous operations and automatic documentation generation.
|
|
2. Pydantic: Used for data validation and serialization, allowing easy definition of data schemas.
|
|
3. SQLModel: Combines SQLAlchemy and Pydantic, enabling database operations with Python classes.
|
|
4. Alembic: A tool for managing database migrations, making it easy to track and apply changes to the database schema.
|
|
5. PostgreSQL: A reliable relational database used for data storage.
|
|
6. Docker Compose: Simplifies the deployment of the application and its dependencies in containers.
|
|
|
|
|
|
### **Installation Instructions**
|
|
|
|
For development:
|
|
|
|
1. Clone the repository:
|
|
```bash
|
|
git clone https://github.com/wowlikon/bookapi.git
|
|
```
|
|
|
|
2. Navigate to the project directory:
|
|
```bash
|
|
cd bookapi
|
|
```
|
|
|
|
3. Copy and configure environment variables:
|
|
```bash
|
|
cp .env.example .env
|
|
```
|
|
|
|
4. Build the Docker containers:
|
|
```bash
|
|
docker-compose build --no-cache
|
|
```
|
|
|
|
5. Run the application:
|
|
```bash
|
|
docker-compose up
|
|
```
|
|
|
|
For make new migrations:
|
|
```bash
|
|
docker-compose run api alembic revision --autogenerate -m "Migration name"
|
|
```
|
|
|
|
For apply migrations:
|
|
|
|
1. Build the Docker containers:
|
|
```bash
|
|
docker-compose build --no-cache
|
|
```
|
|
|
|
2. Run database container:
|
|
```bash
|
|
docker-compose up -d db
|
|
```
|
|
|
|
3. Run this command:
|
|
```bash
|
|
docker-compose run --rm api alembic upgrade head
|
|
```
|
|
|
|
|
|
### **API Endpoints**
|
|
|
|
**Authors**
|
|
| Method | Endpoint | Description |
|
|
|--------|-------------------|--------------------------------------|
|
|
| POST | `/author` | Create a new author |
|
|
| GET | `/author` | Retrieve a list of all authors |
|
|
| PUT | `/author/{id}` | Update a specific author by ID |
|
|
| DELETE | `/author/{id}` | Delete a specific author by ID |
|
|
|
|
**Books**
|
|
| Method | Endpoint | Description |
|
|
|--------|-------------------|--------------------------------------|
|
|
| POST | `/books` | Create a new book |
|
|
| GET | `/books` | Retrieve a list of all books |
|
|
| PUT | `/books/{id}` | Update a specific book by ID |
|
|
| DELETE | `/books/{id}` | Delete a specific book by ID |
|
|
|
|
|
|
### **Technologies Used**
|
|
|
|
- **FastAPI**: A modern web framework for building APIs with Python, known for its speed and ease of use.
|
|
- **Pydantic**: A data validation and settings management library that uses Python type annotations.
|
|
- **SQLModel**: A library for interacting with databases using Python classes, combining the features of SQLAlchemy and Pydantic.
|
|
- **Alembic**: A lightweight database migration tool for use with SQLAlchemy.
|
|
- **PostgreSQL**: A powerful, open-source relational database management system.
|
|
- **Docker**: A platform for developing, shipping, and running applications in containers.
|
|
- **Docker Compose**: A tool for defining and running multi-container Docker applications.
|
|
|
|
|
|
### **TODO List**
|
|
|
|
- Split models for API and database
|
|
- Implement tests
|