Skip to content
Permalink

Comparing changes

This is a direct comparison between two commits made in this repository or its related repositories. View the default comparison for this range or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: microsoft/typespec
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 79b74873f34467c1c175ad53f41aa09c97703cd7
Choose a base ref
..
head repository: microsoft/typespec
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: b996605cd75032b76a27a778dc60faa5319fc400
Choose a head ref
Showing with 5 additions and 5 deletions.
  1. +5 −5 docs/emitters/code-generation/server/server-code-generation.md
10 changes: 5 additions & 5 deletions docs/emitters/code-generation/server/server-code-generation.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Generating server stubs with typespec: a user guide
# Generating server stubs with TypeSpec: a user guide

This guide will walk you through the process of generating server stubs from your TypeSpec API specifications, enabling you to quickly scaffold and develop your backend services.

@@ -31,7 +31,7 @@ Before you begin, make sure you have the following installed:
You can use the Server Stub Generation feature from TypeSpec in two ways:

1. **Command-line interface (CLI):** Ideal for automated builds and developers comfortable with the command line.
2. **Visual studio code (VSCode) IDE with the typespec extension:** Provides a seamless, integrated development experience within VSCode.
2. **Visual studio code (VSCode) IDE with the TypeSpec extension:** Provides a seamless, integrated development experience within VSCode.

## Configuring `tspconfig.yaml` for server stub generation

@@ -77,7 +77,7 @@ npm install -D @typespec/openapi3 @typespec/http-client-csharp @typespec/http-cl
## Using the cli to generate server stubs
1. **Create a typespec project:** If you don't already have one, create a new TypeSpec project using `tsp init`.
1. **Create a TypeSpec project:** If you don't already have one, create a new TypeSpec project using `tsp init`.

```bash
mkdir my-api
@@ -89,7 +89,7 @@ npm install -D @typespec/openapi3 @typespec/http-client-csharp @typespec/http-cl

2. **Define your api:** Write your API specification in a `.tsp` file (e.g., `main.tsp`). This is where you define your models, operations, and routes.

3. **Compile your typespec:** Use the `tsp compile` command to generate server stubs and other artifacts based on your specification.
3. **Compile your TypeSpec:** Use the `tsp compile` command to generate server stubs and other artifacts based on your specification.

```bash
tsp compile .
@@ -331,7 +331,7 @@ The TypeSpec Extension for VSCode offers a convenient way to generate server stu
1. **Install the extension:** Search for "TypeSpec" in the VSCode Extensions Marketplace and install the official TypeSpec extension.
2. **Create a typespec project:**
2. **Create a TypeSpec project:**
* Click “Create TypeSpec Project” in the EXPLORE sidebar.
* `[Placeholder: Screenshot showing "Create TypeSpec Project" in the VSCode Explorer sidebar]`
* Select a project root folder.