-1
日增长
5,947
stars
424
forks
44
watchers
7,395
prs
4,959
issues
620
releases

README

TypeSpec

Official Docs | Try TypeSpec Online | Getting Started | Language Overview

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 code, documentation, and other assets 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.

TypeSpec is a Microsoft-built, community-supported project. Your ideas, feedbacks, and code make all the difference and we deeply appreciate the support from the community.

 Installation


npm install -g @typespec/compiler


 Tools

The TypeSpec VS Code extension can be installed from the VS Code marketplace or directly on the command line:


tsp code install


The TypeSpec VS Extension can be installed from the VS Marketplace or directly on the command line:


tsp vs install


 Usage

 TypeSpec to OpenAPI 3.0 Example

This example uses the @typespec/http, @typespec/rest, and @typespec/openapi3 libraries to define a basic REST service and generate an OpenAPI 3.0 document from it.

Run the following command and select "Generic REST API":


tsp init


Hit enter a few times to confirm the defaults.

Copy the contents below into your main.tsp:

typespec
import "@typespec/http";
import "@typespec/rest";
import "@typespec/openapi3";

using Http;
using Rest;

/ This is a pet store service. /
@service({ title: "Pet Store Service" })
@server("https://example.com", "The service endpoint")
namespace PetStore;

@route("/pets")
interface Pets {
  list(): Pet[];
}

model Pet {
  @minLength(100)
  name: string;

  @minValue(0)
  @maxValue(100)
  age: int32;

  kind: "dog" | "cat" | "fish";
}


Install the dependencies of main.tsp:


tsp install


Compile it to OpenAPI 3.0:


tsp compile main.tsp --emit @typespec/openapi3


You can find the emitted OpenAPI output in ./tsp-output/openapi.json.

 Advanced Scenarios

 Installing nightly version

On every commit to the main branch, packages with changes are automatically published to npm with the @next tag.
The packages section shows which version corresponds to the next tag for each package.

To use a nightly version of the packages, go over each one of the packages in the package.json file and update it to either the latest published @next version or @latest, whichever is the newest. You can also use the tag latest or next instead of an explicit version.

After updating the package.json fi

Top issues

Discussions

Latest release

[email protected] [email protected] 2026-11-11
@typespec/compiler


 Deprecations

- 11980 getDiscriminatedUnionFromInheritance(type, discriminator) is deprecated. Pass the program as the first argument so enum member discriminator values use their @encodedName.
  
  ts
  const [union, diagnostics] = getDiscriminatedUnionFromInheritance(program, type, discriminator);
  

 Features

- 12095 Inspect inline suppressions and local linter disables without compiling a project. Inline results include declaration context and source locations; config results include rule-key locations and diagnostics. For compiled programs, inspect whether each pro

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON