22skowron/witcher-wiki-api repository overview

⁠Witcher Wiki API

⁠Description

This is a simple Flask-based REST API that provides JSON data about characters from the Witcher universe. It is designed as a headless backend service that can be consumed by web apps or other services.

⁠Features

• REST-style API
• JSON responses
• Character data loaded from an external JSON file
• Lightweight and stateless design

⁠Endpoints

GET /api

• Returns basic API information and available endpoints

GET /api/characters

• Returns all available characters

GET /api/characters/<char_id>

• Returns JSON data for a specific character
• Returns 404 if the character does not exist

GET /healthz

• Health check endpoint

⁠Configuration

The application listens on port 5000 by default.

You can override the port using the PORT environment variable.

⁠Container Usage

If running in a container, expose and map the chosen port accordingly.

Example:

docker run -p 5000:5000 --name witcher-wiki-api 22skowron/witcher-wiki-api

⁠Note

ℹ️ This application is intended for learning purposes and experimenting with containers and Kubernetes.