README
¶
Pokémon Studio Data API
A Go-based REST API for accessing Pokémon Studio project data.
Features
- Pokemon: List and get details
- Types: Query type relationships
- Abilities: Access ability information
- Moves: Coming soon
Quick Start
# Run with Docker
docker run -p 8000:8000 -v /path/to/data:/data foreternelle/pokemon-studio-data-api
Documentation
All documentation is available in the Wiki:
| Page | Description |
|---|---|
| Installation | Docker and source installation |
| Development Setup | Local development environment |
| Project Structure | Code organization |
API Reference
The API is documented with OpenAPI 3.0. See docs/api/openapi.yml for the full specification.
Configuration
| Flag | Default | Description |
|---|---|---|
-port |
8000 |
Server port |
-cors |
* |
CORS headers |
-data |
data |
Data directory |
-log-level |
INFO |
Logging level |
Development
See Development Setup for:
- Mise-based development environment
- Available commands
- Code generation workflow
Documentation
¶
There is no documentation for this package.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.