Skip to content

Commit

Permalink
Merge pull request #543 from FreeBono/add-restsharp-doc
Browse files Browse the repository at this point in the history
Add instructions for API Dash-generated code in csharp(RestSharp)
  • Loading branch information
ashitaprasad authored Jan 23, 2025
2 parents b2c61e9 + 2a6dbe5 commit 3b4ceb6
Showing 1 changed file with 76 additions and 1 deletion.
77 changes: 76 additions & 1 deletion doc/user_guide/instructions_to_run_generated_code.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,82 @@ Once you have .NET(C#) and `HttpClient` installed, follow these steps to execute

## C# (RestSharp)

TODO
Here are the detailed instructions for running the generated API Dash code in C# (using RestSharp) 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. **Install `RestSharp`**
- Go to Tools > NuGet Package Manager > Manage NuGet Packages for Solution.
- Under the Browse tab, search for `RestSharp` and install it.

#### Using the CLI

1. **Create a Project**
```bash
dotnet new console -n RestSharpExample
cd RestSharpExample
```

2. **Install the Package**
```bash
dotnet add package RestSharp
```

### 3. Execute the generated code

Once you have .NET(C#) and `RestSharp` 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 like program.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
```

## Dart (http)

Expand Down

0 comments on commit 3b4ceb6

Please sign in to comment.