Skip to content

Commit 54c36d5

Browse files
Resolve markdown warnings in VS Code README
1 parent 0f97075 commit 54c36d5

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

src/VSCode/README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# REST API Client Code Generator
22

3-
A VS Code extension for generating C# REST API clients from OpenAPI/Swagger specifications.
3+
A VS Code extension for generating C# and TypeScript REST API clients from OpenAPI/Swagger specifications.
44

55
## Installation
66

@@ -16,17 +16,21 @@ You can install this extension in several ways:
1616
- Locate and select the downloaded `.vsix` file
1717

1818
3. **Build from Source**:
19+
1920
```powershell
2021
git clone https://github.com/christianhelle/apiclientcodegen.git
2122
cd apiclientcodegen
2223
./src/build-vscode.ps1
2324
```
25+
2426
Then install the generated `.vsix` file using the method above.
2527

2628
## Features
2729

2830
This extension adds a context menu item **REST API Client Code Generator** when right-clicking on JSON or YAML files in the VS Code explorer. The context menu provides the following code generation options:
2931

32+
### C# Generators
33+
3034
- **NSwag**: Generates a C# REST API Client using NSwag
3135
- **Refitter**: Generates a C# Refit interface using Refitter
3236
- **OpenAPI Generator**: Generates a C# REST API Client using OpenAPI Generator
@@ -51,12 +55,14 @@ This extension adds a context menu item **REST API Client Code Generator** when
5155

5256
![Command Palette](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-command-palette.png)
5357

54-
![C#](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu.png)
58+
![C# Context Menu](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu.png)
5559

56-
![TypeScript](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu-typescript.png)
60+
![TypeScript Context Menu](https://github.com/christianhelle/apiclientcodegen/raw/master/images/vscode-context-menu-typescript.png)
5761

5862
## Requirements
5963

64+
For C# code generation:
65+
6066
- .NET SDK 6.0 or higher
6167
- Java Runtime Environment (for OpenAPI Generator and Swagger Codegen CLI)
6268
- NPM (for AutoREST and NSwag)
@@ -68,23 +74,26 @@ For TypeScript code generation:
6874

6975
The extension uses the `rapicgen` .NET tool to generate the code. If not already installed, you will be prompted to install it when first attempting to generate code.
7076

71-
## Extension Settings
77+
## Settings and Configuration
7278

73-
This extension contributes the following settings:
79+
The extension includes configurable settings:
7480

75-
* `restApiClientCodeGenerator.namespace`: Default namespace to use in generated code (default: "GeneratedCode")
76-
* `restApiClientCodeGenerator.outputDirectory`: Output directory relative to workspace folder (default: same directory as the specification file)
81+
- `restApiClientCodeGenerator.namespace`: Default namespace to use in generated code (default: "GeneratedCode")
82+
- `restApiClientCodeGenerator.outputDirectory`: Output directory relative to workspace folder (default: same directory as the specification file)
7783

7884
## How to Use
7985

8086
1. Right-click on a Swagger/OpenAPI specification file (JSON or YAML) in the VS Code explorer
81-
2. Select "REST API Client Code Generator" in the context menu
82-
3. Choose one of the available code generators
83-
4. The generated C# code will be saved and opened in the editor
87+
2. Select "REST API Client Generator" in the context menu
88+
3. Choose your desired language (C# or TypeScript)
89+
4. Select one of the available generators for that language
90+
5. The generated code will be saved in the configured output directory and opened in the editor
8491

8592
## Dependencies
8693

87-
The code generated by each generator depends on different NuGet packages:
94+
### C# Dependencies
95+
96+
The C# code generated by each generator depends on different NuGet packages:
8897

8998
- **NSwag**: Depends on Newtonsoft.Json
9099
- **Refitter**: Depends on Refit

0 commit comments

Comments
 (0)