27 lines
649 B
Markdown
27 lines
649 B
Markdown
# nexus/backend-api
|
|
|
|
Core REST API for the Nexus platform. Built with Rust (Axum).
|
|
|
|
## Development
|
|
|
|
cargo build
|
|
cargo test
|
|
cargo run -- --port 8080
|
|
|
|
## Environment
|
|
|
|
Copy `.env.example` to `.env` before running locally.
|
|
|
|
## API Reference
|
|
|
|
| Endpoint | Method | Description |
|
|
|----------|--------|-------------|
|
|
| `/health` | GET | Liveness check |
|
|
| `/api/v1/users` | GET | List users |
|
|
| `/api/v1/users/:id` | GET | Get user by ID |
|
|
| `/api/v1/auth/login` | POST | Authenticate |
|
|
| `/api/v1/auth/refresh` | POST | Refresh JWT |
|
|
|
|
## Architecture
|
|
|
|
Request → Axum router → middleware (auth, logging) → handler → SQLx → PostgreSQL
|