@mtd.org/developer-api-spec
v3.0.0
Published
Open API Spec for MTD Developer API
Readme
@mtd.org/developer-api-spec
OpenAPI Specification for the MTD Developer API.
This package provides the complete OpenAPI specification for the Champaign-Urbana Mass Transit District (MTD) Developer API, enabling developers to build transit applications with real-time bus information, route data, and more.
Installation
npm install @mtd.org/developer-api-specpnpm add @mtd.org/developer-api-specUsage
This package exports the OpenAPI specification in both JSON and YAML formats.
JSON Format
import openapi from '@mtd.org/developer-api-spec/openapi.json';
console.log(openapi.info.version);YAML Format
import openapiYaml from '@mtd.org/developer-api-spec/openapi.yml';Use Cases
- Code Generation: Generate type-safe API clients in any language
- API Documentation: Generate interactive API documentation using tools like Swagger UI or Redoc
- API Testing: Create automated API tests using the spec as a reference
- Mock Servers: Generate mock API servers for development and testing
- Schema Validation: Validate API requests and responses against the spec
Related Packages
@mtd.org/developer-api-types- TypeScript type definitions generated from this spec@mtd.org/developer-api-client- Type-safe API client built from this spec
Getting Started with the API
To use the MTD Developer API, you'll need an API key:
- Visit mtd.dev
- Sign up for a free developer account
- Create an API key
- Start building!
Documentation
Full API documentation and guides are available at mtd.dev.
License
Apache-2.0
Support
- Issues: GitHub Issues
- Repository: CUMTD/developer-web
