StationAPI

A GraphQL API that provides nearby Japanese train stations and bus stops, running on Cloudflare Workers.

Documentation

• For automation agent and contributor workflows, see AGENTS.md.
• For contribution guidelines, see CONTRIBUTING.md.
• For system architecture and design decisions, see docs/architecture.md.
• For the design of the transfer route search (connectedRoutes, RAPTOR), see docs/route-search.md.
• For technical debt analysis and architectural concerns, see docs/technical_debt.md.
• For the record of the Cloudflare Workers migration, see docs/cloudflare-workers-migration.md.
• For the published GraphQL schema, see schema/public.graphql.

Data Contribution

This project includes a comprehensive dataset of Japanese railway information in the data/ directory. The data is maintained in CSV format and contributions are primarily targeted at Japanese speakers. For detailed information about data structure and contribution guidelines, please refer to data/README.md.

Data Sources

• Track lengths between adjacent stations (Station.trackDistanceFromPrevious) are derived from the MLIT National Land Numerical Information railway data (N02), licensed under CC BY 4.0: 「国土数値情報（鉄道データ）」（国土交通省） (https://nlftp.mlit.go.jp/ksj/gml/datalist/KsjTmplt-N02-2025.html) を加工して作成
• Bus stops and routes are derived from the GTFS and ODPT feeds listed in preprocessor/src/gtfs/feed.rs and preprocessor/src/gtfs/odpt.rs.
• Some of the reference travel times in travel_times/cases.csv are derived from the Toei Subway GTFS (Bureau of Transportation, Tokyo Metropolitan Government, CC BY 4.0) and from the Tokyo Metro, Metropolitan Intercity Railway (Tsukuba Express), Tokyo Waterfront Area Rapid Transit (Rinkai Line), and Tama Toshi Monorail GTFS feeds published by the Public Transportation Open Data Center under the Public Transportation Open Data Basic License.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Kanta Demizu 🔣 🚇 💻

SAIGUSA Tomotada 🤔 🔣

mittan12 🔣

CodeRabbit 👀

tahodev 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Join our community(Japanese only)

Do you like this project? Join our Discord community! https://discord.gg/tsemdME9Nz

Development

No database is required. The data is generated into generated/*.csv and embedded into the WASM binary at build time.

rustup target add wasm32-unknown-unknown
cargo install worker-build --locked

make data     # build generated/*.csv from data/, the GTFS feeds, and the MLIT railway data
make build    # build the Worker (wasm)
make dev      # run it locally on http://127.0.0.1:8787

make help lists every target.

Testing

make test     # unit tests for every native crate
make check    # type-check, including the wasm32 target
make clippy   # lint, including the wasm32 target
make fmt      # formatting check

Tests need no external services. stationapi (domain / use case) and preprocessor (data pipeline) are covered by unit tests; the published GraphQL schema is verified in CI by diffing the Worker's SDL against schema/public.graphql.

Deploying

make deploy             # staging   -> stationapi-stg
make deploy-production  # production -> stationapi

The data lives inside the WASM binary, so a data change needs a rebuild and a redeploy; it is not picked up at runtime.