Repository navigation
Project Status
An honest summary of where the project stands. This page is updated whenever the state changes.
| Area | State |
|---|---|
| Vision, principles, scope | Written (these pages) |
| Domain model and endpoint plan | Drafted; to be reviewed before implementation |
| Architecture (language-neutral) | Drafted |
| Technology evaluation | Done: every group evaluated, with verdicts |
| Go, Rust and TypeScript architectures | Drafted, at the same depth, compared on [[Stack Comparison |
| Stack decision | Taken: Go ([[ADR-0001 |
| Benchmark | Not run yet |
| Technical specification | Drafted (revision 1): [[Technical Specification |
| Logical data model | Drafted: [[Data Model |
| Testing strategy and test plans | Drafted: [[Testing Strategy |
| Licence matrix for the API | Pending review; until it is signed off, the licence gate denies by default |
| Code | Milestone 0.2.0 in review (pull requests #23 to #28, not merged): service skeleton and configuration layer, synthetic fixture generator, container image and local stack, CI and release process, security checks, requirement report. See [[Container and Deployment |
| Public endpoint | None yet |
There is no running ViaFrei API at this time. Nothing on these pages is a measurement of one. ViaFrei's data is available today through its MCP server for AI assistants and on viafrei.de.
- Where the access store lives: a separate schema owned by the API repository (the working assumption), or a separate small database.
- Plans and defaults: whether there is a free public tier, and the default limits of each plan.
- Deployment timing: start small with a tight memory limit, or wait for more capacity.
- The licence matrix: for each source family, whether it may be served over the API, to which use classes, and with which conditions.
-
The public host name:
api.viafrei.deis recommended, with the version in the path. See API Address.
Phase 1 on the Roadmap: review and merge milestone 0.2.0, run the benchmark as the validation of ADR-0001, review the licence matrix. Then phase 2, the contract and version sync.
ViaFrei API: a public, keyed, read-only REST API to live German mobility data. Design phase; nothing on these pages is a measurement of a running service. Data on viafrei.de and in every API answer is attributed to its publishers under their licences.
About
Design
- Domain Model
- API Design
- Architecture Overview
- Security and Access Keys
- Rate Limits and Priority
- Performance and Caching
- Configuration
- Observability
Data Model
Technical specification
-
Technical Specification
- Interface
- Scope, Conventions and References
- Protocol
- Common Envelope
- Resource Model
- Endpoints, Places
- Endpoints, Roads
- Endpoints, Energy and Parking
- Endpoints, Public Transport and Accessibility
- Endpoints, Weather Risk, Driving Rules and Composed Features
- Service Endpoints
- Errors
- Authentication and Authorisation
- Rate Limiting, Quotas and Priority
- Data Licensing and Attribution
- Compatibility and Versioning
- OpenAPI Skeleton
- Quality
- Delivery and operations
- Interface
Testing
- Testing Strategy
- Testing and Quality (design summary)
Engineering
Technology choice
- Technology Evaluation
- Architecture: Go
- Architecture: Rust
- Architecture: TypeScript
- Stack Comparison
- Benchmark Plan
Reference