Map Pathfinder API

A Rust-based REST API for storing maps and finding paths in grid-based mazes with toroidal topology (wrapping edges).

Features

• Store 2D grid maps with walls (#) and empty spaces ( )
• Find shortest paths using BFS algorithm
• Toroidal map topology (edges wrap around)
• RESTful API with CRUD operations
• Pagination support
• Input validation

Technology Stack

• Rust with Axum web framework
• Tokio for async runtime
• UUID for unique identifiers
• Chrono for timestamps

API Endpoints

Maps

• POST /api/v1/maps - Create a new map
• GET /api/v1/maps - List all maps (with pagination)
• GET /api/v1/maps/:id - Get specific map
• DELETE /api/v1/maps/:id - Delete a map

Path Finding

• POST /api/v1/maps/:id/solve - Find path between two points

Installation & Running

Prerequisites

• Rust 1.70+ and Cargo
• Git
• GPG (for signed commits)

Build and Run

# Clone repository
git clone <repository-url>
cd map-pathfinder-api

# Build
cargo build --release

# Run
cargo run