API Specifications

TypeSpec

TypeSpec (formerly Cadl) is a language for describing API shapes developed by Microsoft. TypeSpec definitions emit OpenAPI 3.x, JSON Schema, Protobuf, and other artifacts, and serve as the upstream source for Azure SDK generation. TypeSpec is MIT licensed and maintained on GitHub under the microsoft organization.

GitHub

Documentation

📖
Documentation
https://typespec.io/docs

SDKs

📦
GitHubRepository
https://github.com/microsoft/typespec

Examples

📝
Example
TypeSpec Specification Record Example

Other Resources

🔗
Specification
TypeSpec Language Reference
🔗
GitHubOrganization
Microsoft GitHub (governing org)
🔗
Governance
TypeSpec Governance
🔗
License
MIT

API entry from apis.yml

apis.yml Raw ↑ 
aid: specifications:typespec
name: TypeSpec
description: TypeSpec (formerly Cadl) is a language for describing API shapes developed by Microsoft.
  TypeSpec definitions emit OpenAPI 3.x, JSON Schema, Protobuf, and other artifacts, and serve as the
  upstream source for Azure SDK generation. TypeSpec is MIT licensed and maintained on GitHub under the
  microsoft organization.
humanURL: https://typespec.io/
baseURL: https://typespec.io/docs
tags:
- TypeSpec
- Microsoft
- IDL
- API Design
- Specification Language
properties:
- type: Documentation
  url: https://typespec.io/docs
- type: Specification
  url: https://typespec.io/docs/language-basics/overview
  title: TypeSpec Language Reference
- type: GitHubRepository
  url: https://github.com/microsoft/typespec
- type: GitHubOrganization
  url: https://github.com/microsoft
  title: Microsoft GitHub (governing org)
- type: Governance
  url: https://github.com/microsoft/typespec/blob/main/GOVERNANCE.md
  title: TypeSpec Governance
- type: License
  url: https://opensource.org/license/mit
  title: MIT
- type: Example
  url: https://raw.githubusercontent.com/api-evangelist/specifications/refs/heads/main/examples/typespec-example.json
  title: TypeSpec Specification Record Example