Merge pull request #539 from FreeBono/add-document-csharp

Add instructions for API Dash-generated code in csharp(HttpClient)
This commit is contained in:
Ashita Prasad
2025-01-18 23:41:46 +05:30
committed by GitHub

View File

@ -43,7 +43,75 @@ TODO
## C# (HttpClient)
TODO
Here are the detailed instructions for running the generated API Dash code in C# (using `HttpClient`) for macOS, Windows, and Linux:
### 1. Setting Up the C# Development Environment
#### macOS and Windows:
1. **Install .NET SDK:**
- Visit the [official .NET download page](https://dotnet.microsoft.com/download).
- Download and install the latest .NET SDK for macOS.
2. **Verify Installation:**
- Open the terminal and run the following command to verify the installation:
```bash
dotnet --version
```
#### Linux:
1. **Install .NET SDK:**
- Run the following commands based on your distribution:
- For Ubuntu/Debian-based systems:
```bash
sudo apt update
sudo apt install dotnet-sdk-7.0
```
- For Fedora/CentOS-based systems:
```bash
sudo dnf install dotnet-sdk-7.0
```
2. **Verify Installation:**
- Open the terminal and run the following command to verify the installation:
```bash
dotnet --version
```
### 2. Preparing a Project
#### In Visual Studio:
1. **Create a New Project:**
- Open Visual Studio and select **Create a new project**.
- Choose the **Console Application (.NET Core)** template and create the project.
2. **Check `System.Net.Http` Namespace:**
- `HttpClient` is included by default. No additional installation is required.
#### Using the CLI:
1. **Create a Project:**
```bash
dotnet new console -n HttpClientExample
cd HttpClientExample
```
2. **Install the Package (if necessary):**
```bash
dotnet add package System.Net.Http
```
### 3. Execute the generated code:
Once you have .NET(C#) and `HttpClient` installed, follow these steps to execute the generated code:
1. **Open a IDE/text editor** ✍️ (Visual Studio, VS Code or any other text editor).
2. **Copy the generated code** 📋 from API Dash.
3. **Paste the code** into your project. ex) prgoram.cs
#### In Visual Studio:
1. Click the **Start Debugging (F5)** button from the top menu to run the project.
2. The output window will display the API response.
#### Using the CLI:
1. Open the terminal at the project root directory and run the following command:
```bash
dotnet run
```
## C# (RestSharp)