https://github.com/fromsko/douban_api
Douban-Top250 - Go-server
https://github.com/fromsko/douban_api
Last synced: 4 months ago
JSON representation
Douban-Top250 - Go-server
- Host: GitHub
- URL: https://github.com/fromsko/douban_api
- Owner: Fromsko
- Created: 2025-04-06T15:36:26.000Z (about 1 year ago)
- Default Branch: go
- Last Pushed: 2025-04-15T11:14:57.000Z (about 1 year ago)
- Last Synced: 2025-07-02T01:36:06.304Z (12 months ago)
- Language: HTML
- Homepage:
- Size: 1020 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-py.md
Awesome Lists containing this project
README
# Douban API
## Overview
This repository contains the Douban API implementation using FastAPI.
## Branches
- **py**: Contains the FastAPI implementation of the Douban API.
- **go**: An empty branch for future development.
## Getting Started
### Prerequisites
- Python 3.8 or higher
- Poetry
### Cloning the Repository
1. Clone the repository:
```bash
git clone https://github.com/Fromsko/douban_api.git
cd douban_api
```
2. Checkout the `py` branch:
```bash
git checkout py
```
### Setting Up the Environment
1. Install dependencies using Poetry:
```bash
poetry install
```
2. Activate the virtual environment:
```bash
poetry shell
```
### Running the Application
1. Start the FastAPI application:
```bash
uvicorn douban_api.web.application:app --reload
```
2. Access the API documentation:
- Open your browser and go to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) for Swagger UI.
- Alternatively, go to [http://127.0.0.1:8000/redoc](http://127.0.0.1:8000/redoc) for ReDoc.
## Contributing
Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to the project.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.