You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/VSCode/README.md
+42-1Lines changed: 42 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ You can install this extension in several ways:
21
21
22
22
## Features
23
23
24
-
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:
24
+
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. Additionally, it provides a **Generate Refitter Output** command when right-clicking on `.refitter` settings files. The context menu provides the following code generation options:
25
25
26
26
### C# Generators
27
27
@@ -45,6 +45,10 @@ This extension adds a context menu item **REST API Client Code Generator** when
45
45
-**Redux Query**: Generates a TypeScript REST API Client for Redux Query
46
46
-**RxJS**: Generates a TypeScript REST API Client for RxJS
47
47
48
+
### Refitter Settings Support
49
+
50
+
-**Generate Refitter Output**: When right-clicking on a `.refitter` settings file, you can generate C# Refit interfaces using Refitter with custom configuration. This allows for advanced Refitter configurations including custom settings for authentication, serialization, and other Refitter-specific options.
@@ -77,12 +81,49 @@ The extension includes configurable settings:
77
81
78
82
## How to Use
79
83
84
+
### For OpenAPI/Swagger Specifications
85
+
80
86
1. Right-click on a Swagger/OpenAPI specification file (JSON or YAML) in the VS Code explorer
81
87
2. Select "REST API Client Generator" in the context menu
82
88
3. Choose your desired language (C# or TypeScript)
83
89
4. Select one of the available generators for that language
84
90
5. The generated code will be saved in the configured output directory and opened in the editor
85
91
92
+
### For Refitter Settings Files
93
+
94
+
1. Create a `.refitter` settings file with your Refitter configuration
95
+
2. Right-click on the `.refitter` file in the VS Code explorer
96
+
3. Select "Generate Refitter Output" from the context menu
97
+
4. The generated C# Refit interfaces will be created according to your settings file configuration
98
+
99
+
## Refitter Settings Files
100
+
101
+
The extension supports Refitter settings files (`.refitter`) which allow you to configure advanced options for generating C# Refit interfaces. A typical `.refitter` settings file includes:
0 commit comments