As an open-source project, microsoft/typespec has picked up 5.9k stars on GitHub (Java).
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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:
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 file you can run npm update --force. Force is required as there might be some incompatible version requirement.
Example
// Stable setup
"dependencies": {
"@typespec/compiler": "~0.30.0",
"@typespec/http": "~0.14.0",
"@typespec/rest": "~0.14.0",
"@typespec/openapi": "~0.9.0",
}
// Consume next version
// In this example: compiler and openapi have changes but rest library has none
"dependencies": {
"@typespec/compiler": "~0.31.0-dev.5",
"@typespec/http": "~0.14.0",
"@typespec/rest": "~0.14.0", // No changes to @typespec/rest library so need to stay the latest.
"@typespec/openapi": "~0.10.0-dev.2",
}
Packages
Name
Changelog
Latest
Next
Core functionality
@typespec/compiler
Changelog
TypeSpec Libraries
@typespec/http
Changelog
@typespec/rest
Changelog
@typespec/openapi
Changelog
@typespec/openapi3
Changelog
@typespec/versioning
Changelog
TypeSpec Tools
@typespec/prettier-plugin-typespec
Changelog
typespec-vs
Changelog
typespec-vscode
Changelog
tmlanguage-generator
Changelog
@next version of the package are the latest versions available on the main branch.
The most recent commit recorded on microsoft/typespec was 4 days ago, based on the GitHub push timestamp. The repository has 424 forks — one of the better signals of community interest.
How many stars does microsoft/typespec have?
microsoft/typespec has 5.9k GitHub stars — refresh the page for the live number, or check github.com/microsoft/typespec. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is microsoft/typespec open source?
Yes — microsoft/typespec ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/microsoft/typespec.
What is microsoft/typespec?
microsoft/typespec (microsoft/typespec) is a Java project tracked by TopGit. The repository has 5.9k GitHub stars at the time of our last sync.
Where do I read more about microsoft/typespec?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/microsoft/typespec is the definitive source.
Read full README in the tab above.
Curious whether typespec is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about typespec.