Download
TypeSpec is a language for defining cloud service APIs and shapes. TypeSpec is a highly extensible language with primitives that can describe API shapes common among REST, OpenAPI, gRPC, and other protocols. TypeSpec is excellent for generating many different API description formats, client and service codes, documentation, and many other assets. All this while keeping your TypeSpec definition as a single source of truth. Using TypeSpec, you can create reusable patterns for all aspects of an API and package those reusable patterns into libraries. These patterns establish "guardrails" for API designers and make it easier to follow best practices than to deviate from them. TypeSpec also has a rich linter framework with the ability to flag anti-patterns as well as an emitter framework that lets you control the output to ensure it follows the patterns you want.
Features
- With TypeSpec, remove the handwritten files that slow you down, and generate standards-compliant API schemas in seconds
- Inspired by TypeScript, TypeSpec is a minimal language that helps developers describe API shapes in a familiar way
- Documentation available
- Examples available
- Write TypeSpec, emit to various formats and integrate with their ecosystems
- TypeSpec's standard library includes support for OpenAPI 3.0, JSON Schema 2020-12 and Protobuf
- Benefit from a huge ecosystem of OpenAPI tools for configuring API gateways, generating code, and validating your data
Project Samples
