From 5a7b5274a9d0db09bfdb557de40a98cee118b61c Mon Sep 17 00:00:00 2001 From: Affan Shaikhsurab <51104750+AffanShaikhsurab@users.noreply.github.com> Date: Tue, 14 Jan 2025 16:27:15 +0530 Subject: [PATCH 01/12] Add detailed instructions for running API Dash-generated code in Kotlin using okhttp3 Add detailed instructions for running API Dash-generated code in Kotlin using okhttp3, including steps for installing Kotlin, adding dependencies, and executing the code on macOS, Windows, and Linux. --- .../instructions_to_run_generated_code.md | 40 ++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index ce5c9589..8752205b 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -98,8 +98,46 @@ TODO TODO ## Kotlin (okhttp3) +Here are the detailed instructions for running the generated API Dash code in Kotlin (using okhttp3) for macOS, Windows, and Linux: + +### 1. Install Kotlin: +To run Kotlin code, you need to install Kotlin first. You can install Kotlin from the official Kotlin website: + +- Go to [Kotlin Installation Guide](https://kotlinlang.org/docs/getting-started.html#install-kotlin) for detailed steps. +- Remember: `Kotlin is included in each IntelliJ IDEA and Android Studio release. Download and install one of these IDEs to start using Kotlin`. + +Once Kotlin is installed, proceed with adding `okhttp` and running the generated code. + +### 2. Add `okhttp` library: +To use `okhttp3` in your Kotlin project, you need to include it as a dependency. If you're using **Gradle**, follow these steps: + +- Open the `build.gradle` file in your project. +- Add the following dependency in the `dependencies` section: + +```gradle +implementation("com.squareup.okhttp3:okhttp:4.12.0") +``` + +- Sync your project to apply the dependency. + +### 3. Execute the generated code: +After setting up Kotlin and `okhttp3`, follow these steps to run the generated code: + +1. **Open your IDE** ✍️ (like Android Studio). +2. **Create a new Kotlin file** πŸ“ (or use an existing one). +3. **Copy the generated code** πŸ“‹ from API Dash. +4. **Paste the code** into the Kotlin file πŸ”„. +5. **Run the Kotlin file** by clicking the "Run" button in your IDE or by using the command line. + +#### If you're running from the command line: +1. **Navigate to the project directory** using the terminal or command prompt. +2. **Compile and run the Kotlin file** with these commands: + +```bash +kotlinc api_test.kt -include-runtime -d api_test.jar +java -jar api_test.jar +``` -TODO ## PHP (curl) From f0e90ad4c299ff83ff0abfcd0b6885e9967dcde9 Mon Sep 17 00:00:00 2001 From: Affan Shaikhsurab <51104750+AffanShaikhsurab@users.noreply.github.com> Date: Tue, 14 Jan 2025 16:38:54 +0530 Subject: [PATCH 02/12] Add instructions to run API Dash-generated code in Dart (dio) Add instructions to run API Dash-generated code in Dart (dio) --- .../instructions_to_run_generated_code.md | 93 ++++++++++++++++++- 1 file changed, 91 insertions(+), 2 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index ce5c9589..2b9c796b 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -51,11 +51,100 @@ TODO ## Dart (http) -TODO +Here are the detailed instructions for running the generated API Dash code in **Dart (using `http`)** for macOS, Windows, and Linux: + +--- + +### **1. Install Dart** +To run Dart code, you need to install the Dart SDK. + +- Visit the official **[Dart Installation Guide](https://dart.dev/get-dart)** for step-by-step instructions for macOS, Windows, and Linux. +- Follow the guide to install Dart globally on your system. + +--- + +### **2. Add the `http` Package** +To use the `http` package in Dart, you need to add it as a dependency in your project. + +1. Create a new Dart project by running the following command in the terminal: + ```bash + dart create my_dart_project + cd my_dart_project + ``` +2. Open the `pubspec.yaml` file in the project directory. +3. Add the following line under the `dependencies` section: + ```yaml + dependencies: + http: ^1.2.2 + ``` +4. Run the following command to fetch the dependency: + ```bash + dart pub get + ``` + +--- + +### **3. Run the Generated Code** +After setting up Dart and the `http` package, follow these steps to execute the generated code: + +#### **Using a Text Editor or IDE (e.g., Visual Studio Code):** +1. Open a text editor or an IDE like Visual Studio Code. +2. Create a new Dart file, such as `api_test.dart`. +3. Copy the generated code from API Dash and paste it into this file. +4. Save the file. +5. Run the Dart file using the terminal or the IDE's built-in tools. + +#### **Using the Command Line:** +1. Save the generated code to a Dart file, e.g., `api_test.dart`. +2. Open a terminal and navigate to the directory containing the file. +3. Run the Dart file with the following command: + ```bash + dart run api_test.dart + ``` + +With these steps, you can successfully run API Dash-generated code in Dart using the `http` package! πŸš€ ## Dart (dio) -TODO +Here are the detailed instructions for running the generated API Dash code in **Dart (using `dio`)** for macOS, Windows, and Linux: + +--- + +### **1. Install Dart** +To run Dart code, you need to install the Dart SDK. + +πŸ‘‰ Follow the instructions provided above under **Dart (http)** for detailed steps on how to install Dart on macOS, Windows, and Linux. + +--- + +### **2. Add the `dio` Package** +To use the `dio` package in Dart, you need to add it as a dependency in your project. + +1. Create a new Dart project by running the following command in the terminal: + ```bash + dart create my_dart_project + cd my_dart_project + ``` +2. Open the `pubspec.yaml` file in the project directory. +3. Add the following line under the `dependencies` section: + ```yaml + dependencies: + dio: ^5.7.0 + ``` +4. Run the following command to fetch the dependency: + ```bash + dart pub get + ``` +--- + +### **3. Run the Generated Code** +After setting up Dart and the `dio` package, follow these steps to execute the generated code: + +πŸ‘‰ Refer to the instructions under **Dart (http)** for details on how to execute the Dart file using an IDE or the terminal. + +--- + +With these steps, you can successfully run API Dash-generated code in Dart using the `dio` package! πŸš€ ## Go (net/http) From ca7e29a9054f9e9a07060f74209674bdb545c8be Mon Sep 17 00:00:00 2001 From: Affan Shaikhsurab <51104750+AffanShaikhsurab@users.noreply.github.com> Date: Wed, 15 Jan 2025 12:48:43 +0530 Subject: [PATCH 03/12] Add platform-specific instructions for running API Dash-generated Java Add platform-specific instructions for running API Dash-generated Java code using AsyncHttpClient, HttpClient, OkHttp3, and Unirest libraries. --- .../instructions_to_run_generated_code.md | 173 +++++++++++++++++- 1 file changed, 169 insertions(+), 4 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index ce5c9589..11d5e02e 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -79,19 +79,184 @@ TODO ## Java (asynchttpclient) -TODO +Here are the detailed instructions for running the generated API Dash code in **Java (using `AsyncHttpClient`)** for macOS, Windows, and Linux: + +--- + +### **1. Install Java** +To run Java code, you need to have Java Development Kit (JDK) installed on your system. + +- Visit the official **[Java Downloads Page](https://www.oracle.com/in/java/technologies/downloads/#jdk23)** and follow the instructions to install the latest JDK on macOS, Windows, or Linux. + +After installation, verify it by running: +```bash +java -version +``` + +--- + +### **2. Add the `AsyncHttpClient` Library** +To use the `AsyncHttpClient` library in Java, you need to add it as a dependency in your project. + +#### Using **Maven**: +1. Add the following dependency to your `pom.xml` file: + ```xml + + + org.asynchttpclient + async-http-client + 3.0.1 + + + ``` +3. Save the file and run: + ```bash + mvn install + ``` + +#### Using **Gradle**: +1. Add the following line to the `dependencies` section in your `build.gradle` file: + ```gradle + implementation 'org.asynchttpclient:async-http-client:3.0.1' + ``` +2. Run the following command to fetch the dependency: + ```bash + gradle build + ``` + +--- + +### **3. Run the Generated Code** +After setting up Java and adding the `AsyncHttpClient` library, follow these steps to execute the generated code: + +1. **Create a new Java file**: Save the generated code into a file with a `.java` extension, such as `ApiTest.java`. +2. **Compile the file**: Use the following command in the terminal: + ```bash + javac ApiTest.java + ``` +3. **Run the compiled program**: + ```bash + java ApiTest + ``` + +--- ## Java (HttpClient) -TODO +Here are the detailed instructions for running the generated API Dash code in **Java (using `HttpClient`)** for macOS, Windows, and Linux: + +--- + +### **1. Install Java** +πŸ‘‰ Follow the instructions provided above under **Java (AsyncHttpClient)** for detailed steps on how to install the Java Development Kit (JDK) on macOS, Windows, or Linux. + +--- + +### **2. `HttpClient` Setup** +The `HttpClient` library is included as part of the **Java SE 11** (or later) standard library. +- Ensure you have **Java 11** or a later version installed to use `HttpClient` without needing additional dependencies. + + +To confirm your Java version, run: +```bash +java -version +``` +--- + +### **3. Run the Generated Code** +πŸ‘‰ Refer to the instructions above under **Java (AsyncHttpClient)** for steps to save, compile, and execute the Java code. + +--- ## Java (okhttp3) -TODO +Here are the detailed instructions for running the generated API Dash code in **Java (using `okhttp3`)** for macOS, Windows, and Linux: + +--- + +### **1. Install Java** +πŸ‘‰ Follow the instructions provided above under **Java (AsyncHttpClient)** for detailed steps on how to install the Java Development Kit (JDK) on macOS, Windows, or Linux. + +--- + +### **2. Add the `okhttp3` Library** +To use `okhttp3` in Java, you need to add it as a dependency in your project. + +#### Using **Maven**: +1. Add the following dependency to your `pom.xml` file: + ```xml + + com.squareup.okhttp3 + okhttp + 4.12.0 + + ``` +2. Save the file and run: + ```bash + mvn install + ``` + +#### Using **Gradle**: +1. Add the following line to the `dependencies` section in your `build.gradle` file: + ```gradle + implementation 'com.squareup.okhttp3:okhttp:4.12.0' + ``` +2. Run the following command to fetch the dependency: + ```bash + gradle build + ``` + +--- + +### **3. Run the Generated Code** +πŸ‘‰ Refer to the instructions provided above under **Java (AsyncHttpClient)** for steps to save, compile, and execute the Java code. + +--- ## Java (Unirest) -TODO +Here are the detailed instructions for running the generated API Dash code in **Java (using `Unirest`)** for macOS, Windows, and Linux: + +--- + +### **1. Install Java** +πŸ‘‰ Follow the instructions provided above under **Java (AsyncHttpClient)** for detailed steps on how to install the Java Development Kit (JDK) on macOS, Windows, or Linux. + +--- + +### **2. Add the `Unirest` Library** +To use `Unirest` in Java, you need to add it as a dependency in your project. + +#### Using **Maven**: +1. Add the following dependency to your `pom.xml` file: + ```xml + + com.konghq + unirest-java + 3.14.1 + + ``` +2. Save the file and run: + ```bash + mvn install + ``` + +#### Using **Gradle**: +1. Add the following line to the `dependencies` section in your `build.gradle` file: + ```gradle + implementation 'com.konghq:unirest-java:3.14.1' + ``` +2. Run the following command to fetch the dependency: + ```bash + gradle build + ``` + +--- + +### **3. Run the Generated Code** +πŸ‘‰ Refer to the instructions provided above under **Java (AsyncHttpClient)** for steps to save, compile, and execute the Java code. + +--- ## Julia (HTTP) From 26a80e5d80c2ba7395558569aca0f7b7791ad872 Mon Sep 17 00:00:00 2001 From: FreeBono Date: Fri, 17 Jan 2025 15:33:57 +0900 Subject: [PATCH 04/12] Add instructions for API Dash-generated code in csharp(HttpClient) --- .../instructions_to_run_generated_code.md | 79 ++++++++++++++++++- 1 file changed, 78 insertions(+), 1 deletion(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index e3bac1fa..3ef3cfdd 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -43,7 +43,84 @@ 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 HttpClient + +#### 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 + + +### 4. Running the Project + +#### 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) From 9d83fe68a370581e6b34e88ca443fa586d5f3a87 Mon Sep 17 00:00:00 2001 From: Ashita Prasad Date: Fri, 17 Jan 2025 22:25:35 +0530 Subject: [PATCH 05/12] Update instructions_to_run_generated_code.md --- .../instructions_to_run_generated_code.md | 87 +++++++------------ 1 file changed, 32 insertions(+), 55 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index 2b9c796b..86d96418 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -51,100 +51,77 @@ TODO ## Dart (http) -Here are the detailed instructions for running the generated API Dash code in **Dart (using `http`)** for macOS, Windows, and Linux: +Here are the detailed instructions for running the generated API Dash code in **Dart (using `http`)** for macOS, Windows, and Linux: ---- +### **1. Install Dart** -### **1. Install Dart** -To run Dart code, you need to install the Dart SDK. +- Visit the official **[Dart Installation Guide](https://dart.dev/get-dart)** for step-by-step installation instructions for macOS, Windows, and Linux. -- Visit the official **[Dart Installation Guide](https://dart.dev/get-dart)** for step-by-step instructions for macOS, Windows, and Linux. -- Follow the guide to install Dart globally on your system. +### **2. Add the `http` Package** ---- - -### **2. Add the `http` Package** -To use the `http` package in Dart, you need to add it as a dependency in your project. - -1. Create a new Dart project by running the following command in the terminal: - ```bash - dart create my_dart_project - cd my_dart_project - ``` -2. Open the `pubspec.yaml` file in the project directory. -3. Add the following line under the `dependencies` section: +- Add the `http` package as a dependency under the `dependencies` section of the `pubspec.yaml` file: ```yaml dependencies: http: ^1.2.2 ``` -4. Run the following command to fetch the dependency: +- Run the following command to fetch the dependency: ```bash dart pub get ``` ---- - -### **3. Run the Generated Code** -After setting up Dart and the `http` package, follow these steps to execute the generated code: +### **3. Run the Generated Code** #### **Using a Text Editor or IDE (e.g., Visual Studio Code):** -1. Open a text editor or an IDE like Visual Studio Code. -2. Create a new Dart file, such as `api_test.dart`. -3. Copy the generated code from API Dash and paste it into this file. -4. Save the file. -5. Run the Dart file using the terminal or the IDE's built-in tools. +1. Open a text editor or an IDE like Visual Studio Code. +2. Create a new Dart file, such as `api_test.dart`. +3. Copy the generated code from API Dash and paste it into this file. +4. Save the file. +5. Run the Dart file using the terminal or the IDE's built-in tools. #### **Using the Command Line:** -1. Save the generated code to a Dart file, e.g., `api_test.dart`. -2. Open a terminal and navigate to the directory containing the file. +1. Save the generated code to a Dart file, e.g., `api_test.dart`. +2. Open a terminal and navigate to the directory containing the file. 3. Run the Dart file with the following command: ```bash dart run api_test.dart ``` -With these steps, you can successfully run API Dash-generated code in Dart using the `http` package! πŸš€ - ## Dart (dio) Here are the detailed instructions for running the generated API Dash code in **Dart (using `dio`)** for macOS, Windows, and Linux: ---- +### **1. Install Dart** -### **1. Install Dart** -To run Dart code, you need to install the Dart SDK. +- Visit the official **[Dart Installation Guide](https://dart.dev/get-dart)** for step-by-step installation instructions for macOS, Windows, and Linux. -πŸ‘‰ Follow the instructions provided above under **Dart (http)** for detailed steps on how to install Dart on macOS, Windows, and Linux. +### **2. Add the `dio` Package** ---- - -### **2. Add the `dio` Package** -To use the `dio` package in Dart, you need to add it as a dependency in your project. - -1. Create a new Dart project by running the following command in the terminal: - ```bash - dart create my_dart_project - cd my_dart_project - ``` -2. Open the `pubspec.yaml` file in the project directory. -3. Add the following line under the `dependencies` section: +- Add the `dio` package as a dependency under the `dependencies` section of the `pubspec.yaml` file: ```yaml dependencies: dio: ^5.7.0 ``` -4. Run the following command to fetch the dependency: +- Run the following command to fetch the dependency: ```bash dart pub get ``` ---- ### **3. Run the Generated Code** -After setting up Dart and the `dio` package, follow these steps to execute the generated code: -πŸ‘‰ Refer to the instructions under **Dart (http)** for details on how to execute the Dart file using an IDE or the terminal. +#### **Using a Text Editor or IDE (e.g., Visual Studio Code):** +1. Open a text editor or an IDE like Visual Studio Code. +2. Create a new Dart file, such as `api_test.dart`. +3. Copy the generated code from API Dash and paste it into this file. +4. Save the file. +5. Run the Dart file using the terminal or the IDE's built-in tools. ---- - -With these steps, you can successfully run API Dash-generated code in Dart using the `dio` package! πŸš€ +#### **Using the Command Line:** +1. Save the generated code to a Dart file, e.g., `api_test.dart`. +2. Open a terminal and navigate to the directory containing the file. +3. Run the Dart file with the following command: + ```bash + dart run api_test.dart + ``` ## Go (net/http) From 37b6c02e9bb465a20bb6e7380539a994bec6f195 Mon Sep 17 00:00:00 2001 From: Ashita Prasad Date: Sat, 18 Jan 2025 23:41:19 +0530 Subject: [PATCH 06/12] Update instructions_to_run_generated_code.md --- doc/user_guide/instructions_to_run_generated_code.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index 3ef3cfdd..2972db05 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -45,7 +45,6 @@ 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:** @@ -57,7 +56,6 @@ Here are the detailed instructions for running the generated API Dash code in C# dotnet --version ``` - #### Linux: 1. **Install .NET SDK:** - Run the following commands based on your distribution: @@ -76,7 +74,7 @@ Here are the detailed instructions for running the generated API Dash code in C# dotnet --version ``` -### 2. Preparing HttpClient +### 2. Preparing a Project #### In Visual Studio: 1. **Create a New Project:** @@ -105,9 +103,6 @@ Once you have .NET(C#) and `HttpClient` installed, follow these steps to execute 2. **Copy the generated code** πŸ“‹ from API Dash. 3. **Paste the code** into your project. ex) prgoram.cs - -### 4. Running the Project - #### 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. @@ -118,10 +113,6 @@ Once you have .NET(C#) and `HttpClient` installed, follow these steps to execute dotnet run ``` - - - - ## C# (RestSharp) TODO From e0de4a231765b0b19be076d77175bae7b9692127 Mon Sep 17 00:00:00 2001 From: Numaan Ahmed <121759269+numaanahmed3110@users.noreply.github.com> Date: Sun, 19 Jan 2025 16:33:59 +0530 Subject: [PATCH 07/12] Update instructions_to_run_generated_code.md Step-by-step guide on how to run API requests using different libraries and methods in JavaScript and Node.js using fetch and axios on major platforms like macOS, Linux, and Windows. --- .../instructions_to_run_generated_code.md | 149 +++++++++++++++++- 1 file changed, 145 insertions(+), 4 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index 47c9ba8f..0cc29deb 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -197,19 +197,160 @@ TODO ## JavaScript (axios) -TODO +`Axios` is a promise-based HTTP client for the browser and Node.js. +### 1. Installation: +-Ensure Node.js and npm are installed. Verify by running: + +```bash +node --version +npm --version +``` +-If not, download from Node.js **[Official Website]((https://nodejs.org/en))**. + +-Initialize a new Node.js project: + +```bash +npm init -y +``` + +-Install Axios: + +```bash +npm install axios +``` + +### 2. Running the Generated Code:: +-Create a new JavaScript file (`e.g., app.js`). +-Copy and paste the generated code into this file. +-Open a terminal and navigate to the project directory. +-Run the script: + +```bash +node app.js +``` ## JavaScript (fetch) -TODO +macOS, Linux, and Windows: +### 1. Node.js: +-Follow the same steps as above to install Node.js. + +### 2. Set Up a New Project: +-Create a new project folder and navigate into it +```bash +mkdir fetch-example +cd fetch-example +``` +-Initialize the project: +```bash +npm init -y +``` + +### 3. Ensure Fetch API Support: +-Starting with Node.js 18, the Fetch API is built-in. Verify the version: + +```bash +node --version +``` + +-If you’re using an earlier version, install a Fetch polyfill: + +```bash +npm install node-fetch +``` + +### 4. Create and Run the Code: +-Save the generated code in a file, e.g., fetch_example.js. +-If using node-fetch, add this line at the top of your file: + +```bash +const fetch = require('node-fetch'); +``` + +-Run the code: + +```bash +node fetch_example.js +``` ## node.js (JavaScript, axios) -TODO +macOS, Linux, and Windows: +### 1.Install Node.js: +-Follow the installation steps above. + +### 2.Set Up a New Project: +-Create a new project directory: + +```bash +mkdir node-axios-example +cd node-axios-example +``` + +-Initialize the project: + +```bash +npm init -y +``` + +### 3.Install Axios: + +-Install the Axios library: + +```bash +npm install axios +``` + +### 4.Create and Run the Code: + +-Save the generated code in a file(` e.g., app.js`). +-Run the code: + +```bash +node app.js +``` ## node.js (JavaScript, fetch) -TODO +macOS, Linux, and Windows: +### 1. Install Node.js: +-Follow the installation steps above. + +### 2. Set Up a New Project: +Create a project directory: + +```bash +mkdir node-fetch-example +cd node-fetch-example +``` + +### 3.Initialize the project: + +```bash +npm init -y +``` + +### 4.Ensure Fetch API Support: +-If using Node.js 18 or newer, the Fetch API is already built-in. +-For older versions, install the `node-fetch` package: + +```bash +npm install node-fetch +``` + +### 5.Create and Run the Code: +-Save the generated code in a file( `e.g., app.js`). +-If using `node-fetch`, add the following line to the top of the file: + +```javascript +const fetch = require('node-fetch'); +``` + +-Run the file: + +```bash +node app.js +``` ## Java (asynchttpclient) From 35287cccdd5c9512fdd735c92f02ade95b37c758 Mon Sep 17 00:00:00 2001 From: Ashita Prasad Date: Tue, 21 Jan 2025 05:04:50 +0530 Subject: [PATCH 08/12] Update instructions_to_run_generated_code.md --- .../instructions_to_run_generated_code.md | 139 ++++++------------ 1 file changed, 46 insertions(+), 93 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index 0cc29deb..dd10a0bd 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -197,114 +197,55 @@ TODO ## JavaScript (axios) -`Axios` is a promise-based HTTP client for the browser and Node.js. -### 1. Installation: --Ensure Node.js and npm are installed. Verify by running: +TODO + +## JavaScript (fetch) + +TODO + +## node.js (JavaScript, axios) + +### 1.Install Node.js: +Ensure Node.js and npm are installed. Verify by running: ```bash node --version npm --version ``` --If not, download from Node.js **[Official Website]((https://nodejs.org/en))**. --Initialize a new Node.js project: +If not, download from Node.js **[Official Website]((https://nodejs.org/en))**. + +Initialize a new Node.js project: ```bash npm init -y ``` --Install Axios: +Install Axios: ```bash npm install axios ``` -### 2. Running the Generated Code:: --Create a new JavaScript file (`e.g., app.js`). --Copy and paste the generated code into this file. --Open a terminal and navigate to the project directory. --Run the script: - -```bash -node app.js -``` - -## JavaScript (fetch) - -macOS, Linux, and Windows: -### 1. Node.js: --Follow the same steps as above to install Node.js. - -### 2. Set Up a New Project: --Create a new project folder and navigate into it -```bash -mkdir fetch-example -cd fetch-example -``` --Initialize the project: -```bash -npm init -y -``` - -### 3. Ensure Fetch API Support: --Starting with Node.js 18, the Fetch API is built-in. Verify the version: - -```bash -node --version -``` - --If you’re using an earlier version, install a Fetch polyfill: - -```bash -npm install node-fetch -``` - -### 4. Create and Run the Code: --Save the generated code in a file, e.g., fetch_example.js. --If using node-fetch, add this line at the top of your file: - -```bash -const fetch = require('node-fetch'); -``` - --Run the code: - -```bash -node fetch_example.js -``` - -## node.js (JavaScript, axios) - -macOS, Linux, and Windows: -### 1.Install Node.js: --Follow the installation steps above. - ### 2.Set Up a New Project: --Create a new project directory: +Create a new project directory: ```bash mkdir node-axios-example cd node-axios-example ``` --Initialize the project: +Initialize the project: ```bash npm init -y ``` -### 3.Install Axios: +### 3.Create and Run the Code: --Install the Axios library: +Save the generated code in a file(e.g., `app.js`). -```bash -npm install axios -``` - -### 4.Create and Run the Code: - --Save the generated code in a file(` e.g., app.js`). --Run the code: +Run the code: ```bash node app.js @@ -312,9 +253,29 @@ node app.js ## node.js (JavaScript, fetch) -macOS, Linux, and Windows: ### 1. Install Node.js: --Follow the installation steps above. +Ensure Node.js and npm are installed. Verify by running: + +```bash +node --version +npm --version +``` + +If not, download from Node.js **[Official Website]((https://nodejs.org/en))**. + +Initialize a new Node.js project: + +```bash +npm init -y +``` + +If using Node.js 18 or newer, the Fetch API is already built-in. + +For older versions, install the `node-fetch` package: + +```bash +npm install node-fetch +``` ### 2. Set Up a New Project: Create a project directory: @@ -324,29 +285,21 @@ mkdir node-fetch-example cd node-fetch-example ``` -### 3.Initialize the project: +Initialize the project: ```bash npm init -y ``` -### 4.Ensure Fetch API Support: --If using Node.js 18 or newer, the Fetch API is already built-in. --For older versions, install the `node-fetch` package: - -```bash -npm install node-fetch -``` - -### 5.Create and Run the Code: --Save the generated code in a file( `e.g., app.js`). --If using `node-fetch`, add the following line to the top of the file: +### 3.Create and Run the Code: +Save the generated code in a file( e.g., `app.js`). +If using `node-fetch`, add the following line to the top of the file: ```javascript const fetch = require('node-fetch'); ``` --Run the file: +Run the file: ```bash node app.js From c845aa6707cbb218c8e2f3df303ff38e521f4d35 Mon Sep 17 00:00:00 2001 From: FreeBono Date: Tue, 21 Jan 2025 20:53:48 +0900 Subject: [PATCH 09/12] Add instructions for API Dash-generated code in csharp(RestSharp) --- .../instructions_to_run_generated_code.md | 45 ++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index dd10a0bd..f1403b02 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -115,7 +115,50 @@ 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 + +Check out the instructions [here](#1-setting-up-the-c-development-environment) for detailed steps on how to set C# Development Environment on macOS, Windows, or Linux. + +### 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. 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 + ``` ## Dart (http) From d0767d85144e0fde98583c9553bf033efe0da0f4 Mon Sep 17 00:00:00 2001 From: Ashita Prasad Date: Tue, 21 Jan 2025 20:40:35 +0530 Subject: [PATCH 10/12] Update instructions_to_run_generated_code.md --- .../instructions_to_run_generated_code.md | 133 ++++++++++++------ 1 file changed, 87 insertions(+), 46 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index 11d5e02e..3b81d0b9 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -81,24 +81,24 @@ TODO Here are the detailed instructions for running the generated API Dash code in **Java (using `AsyncHttpClient`)** for macOS, Windows, and Linux: ---- +### 1. Install Java -### **1. Install Java** -To run Java code, you need to have Java Development Kit (JDK) installed on your system. +To run Java code, you need to have Java Development Kit (JDK) installed on your system. -- Visit the official **[Java Downloads Page](https://www.oracle.com/in/java/technologies/downloads/#jdk23)** and follow the instructions to install the latest JDK on macOS, Windows, or Linux. +- Visit the official **[Java Downloads Page](https://www.oracle.com/in/java/technologies/downloads/#jdk23)** and follow the instructions to install the latest JDK on macOS, Windows, or Linux. + +After installation, verify it by running: -After installation, verify it by running: ```bash java -version ``` ---- +### 2. Add the `AsyncHttpClient` Library -### **2. Add the `AsyncHttpClient` Library** To use the `AsyncHttpClient` library in Java, you need to add it as a dependency in your project. -#### Using **Maven**: +#### Using Maven + 1. Add the following dependency to your `pom.xml` file: ```xml @@ -109,12 +109,13 @@ To use the `AsyncHttpClient` library in Java, you need to add it as a dependency ``` -3. Save the file and run: +2. Save the file and run: ```bash mvn install ``` -#### Using **Gradle**: +#### Using Gradle + 1. Add the following line to the `dependencies` section in your `build.gradle` file: ```gradle implementation 'org.asynchttpclient:async-http-client:3.0.1' @@ -124,9 +125,8 @@ To use the `AsyncHttpClient` library in Java, you need to add it as a dependency gradle build ``` ---- +### 3. Run the Generated Code -### **3. Run the Generated Code** After setting up Java and adding the `AsyncHttpClient` library, follow these steps to execute the generated code: 1. **Create a new Java file**: Save the generated code into a file with a `.java` extension, such as `ApiTest.java`. @@ -139,50 +139,68 @@ After setting up Java and adding the `AsyncHttpClient` library, follow these ste java ApiTest ``` ---- - ## Java (HttpClient) Here are the detailed instructions for running the generated API Dash code in **Java (using `HttpClient`)** for macOS, Windows, and Linux: ---- +### 1. Install Java -### **1. Install Java** -πŸ‘‰ Follow the instructions provided above under **Java (AsyncHttpClient)** for detailed steps on how to install the Java Development Kit (JDK) on macOS, Windows, or Linux. +To run Java code, you need to have Java Development Kit (JDK) installed on your system. ---- +- Visit the official **[Java Downloads Page](https://www.oracle.com/in/java/technologies/downloads/#jdk23)** and follow the instructions to install the latest JDK on macOS, Windows, or Linux. + +After installation, verify it by running: + +```bash +java -version +``` + +### 2. `HttpClient` Setup -### **2. `HttpClient` Setup** The `HttpClient` library is included as part of the **Java SE 11** (or later) standard library. - Ensure you have **Java 11** or a later version installed to use `HttpClient` without needing additional dependencies. - To confirm your Java version, run: ```bash java -version ``` ---- -### **3. Run the Generated Code** -πŸ‘‰ Refer to the instructions above under **Java (AsyncHttpClient)** for steps to save, compile, and execute the Java code. +### 3. Run the Generated Code ---- +After setting up Java and checking the version, follow these steps to execute the generated code: + +1. **Create a new Java file**: Save the generated code into a file with a `.java` extension, such as `ApiTest.java`. +2. **Compile the file**: Use the following command in the terminal: + ```bash + javac ApiTest.java + ``` +3. **Run the compiled program**: + ```bash + java ApiTest + ``` ## Java (okhttp3) Here are the detailed instructions for running the generated API Dash code in **Java (using `okhttp3`)** for macOS, Windows, and Linux: ---- +### 1. Install Java -### **1. Install Java** -πŸ‘‰ Follow the instructions provided above under **Java (AsyncHttpClient)** for detailed steps on how to install the Java Development Kit (JDK) on macOS, Windows, or Linux. +To run Java code, you need to have Java Development Kit (JDK) installed on your system. ---- +- Visit the official **[Java Downloads Page](https://www.oracle.com/in/java/technologies/downloads/#jdk23)** and follow the instructions to install the latest JDK on macOS, Windows, or Linux. + +After installation, verify it by running: + +```bash +java -version +``` + +### 2. Add the `okhttp3` Library -### **2. Add the `okhttp3` Library** To use `okhttp3` in Java, you need to add it as a dependency in your project. -#### Using **Maven**: +#### Using Maven + 1. Add the following dependency to your `pom.xml` file: ```xml @@ -196,7 +214,8 @@ To use `okhttp3` in Java, you need to add it as a dependency in your project. mvn install ``` -#### Using **Gradle**: +#### Using Gradle + 1. Add the following line to the `dependencies` section in your `build.gradle` file: ```gradle implementation 'com.squareup.okhttp3:okhttp:4.12.0' @@ -206,28 +225,42 @@ To use `okhttp3` in Java, you need to add it as a dependency in your project. gradle build ``` ---- +### 3. Run the Generated Code -### **3. Run the Generated Code** -πŸ‘‰ Refer to the instructions provided above under **Java (AsyncHttpClient)** for steps to save, compile, and execute the Java code. +After setting up Java and adding the `okhttp3` library, follow these steps to execute the generated code: ---- +1. **Create a new Java file**: Save the generated code into a file with a `.java` extension, such as `ApiTest.java`. +2. **Compile the file**: Use the following command in the terminal: + ```bash + javac ApiTest.java + ``` +3. **Run the compiled program**: + ```bash + java ApiTest + ``` ## Java (Unirest) Here are the detailed instructions for running the generated API Dash code in **Java (using `Unirest`)** for macOS, Windows, and Linux: ---- +### 1. Install Java -### **1. Install Java** -πŸ‘‰ Follow the instructions provided above under **Java (AsyncHttpClient)** for detailed steps on how to install the Java Development Kit (JDK) on macOS, Windows, or Linux. +To run Java code, you need to have Java Development Kit (JDK) installed on your system. ---- +- Visit the official **[Java Downloads Page](https://www.oracle.com/in/java/technologies/downloads/#jdk23)** and follow the instructions to install the latest JDK on macOS, Windows, or Linux. + +After installation, verify it by running: + +```bash +java -version +``` + +### 2. Add the `Unirest` Library -### **2. Add the `Unirest` Library** To use `Unirest` in Java, you need to add it as a dependency in your project. -#### Using **Maven**: +#### Using Maven + 1. Add the following dependency to your `pom.xml` file: ```xml @@ -241,7 +274,8 @@ To use `Unirest` in Java, you need to add it as a dependency in your project. mvn install ``` -#### Using **Gradle**: +#### Using Gradle + 1. Add the following line to the `dependencies` section in your `build.gradle` file: ```gradle implementation 'com.konghq:unirest-java:3.14.1' @@ -251,12 +285,19 @@ To use `Unirest` in Java, you need to add it as a dependency in your project. gradle build ``` ---- +### 3. Run the Generated Code -### **3. Run the Generated Code** -πŸ‘‰ Refer to the instructions provided above under **Java (AsyncHttpClient)** for steps to save, compile, and execute the Java code. +After setting up Java and adding the `Unirest` library, follow these steps to execute the generated code: ---- +1. **Create a new Java file**: Save the generated code into a file with a `.java` extension, such as `ApiTest.java`. +2. **Compile the file**: Use the following command in the terminal: + ```bash + javac ApiTest.java + ``` +3. **Run the compiled program**: + ```bash + java ApiTest + ``` ## Julia (HTTP) From 83464d3b90eb6031edbd04208bc5a95a59a76b5f Mon Sep 17 00:00:00 2001 From: Ashita Prasad Date: Wed, 22 Jan 2025 20:36:36 +0530 Subject: [PATCH 11/12] Update instructions_to_run_generated_code.md --- .../instructions_to_run_generated_code.md | 35 +++++++++++-------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index 8752205b..17e2a035 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -98,17 +98,18 @@ TODO TODO ## Kotlin (okhttp3) + Here are the detailed instructions for running the generated API Dash code in Kotlin (using okhttp3) for macOS, Windows, and Linux: -### 1. Install Kotlin: -To run Kotlin code, you need to install Kotlin first. You can install Kotlin from the official Kotlin website: +### 1. Install Kotlin + +To run Kotlin code, you need to install Kotlin by following the below instructions: - Go to [Kotlin Installation Guide](https://kotlinlang.org/docs/getting-started.html#install-kotlin) for detailed steps. -- Remember: `Kotlin is included in each IntelliJ IDEA and Android Studio release. Download and install one of these IDEs to start using Kotlin`. +- Kotlin is also included in IntelliJ IDEA and Android Studio. You can also download and install one of these IDEs to start using Kotlin. -Once Kotlin is installed, proceed with adding `okhttp` and running the generated code. +### 2. Add `okhttp` library -### 2. Add `okhttp` library: To use `okhttp3` in your Kotlin project, you need to include it as a dependency. If you're using **Gradle**, follow these steps: - Open the `build.gradle` file in your project. @@ -120,25 +121,29 @@ implementation("com.squareup.okhttp3:okhttp:4.12.0") - Sync your project to apply the dependency. -### 3. Execute the generated code: +### 3. Execute the generated code + After setting up Kotlin and `okhttp3`, follow these steps to run the generated code: -1. **Open your IDE** ✍️ (like Android Studio). -2. **Create a new Kotlin file** πŸ“ (or use an existing one). -3. **Copy the generated code** πŸ“‹ from API Dash. -4. **Paste the code** into the Kotlin file πŸ”„. -5. **Run the Kotlin file** by clicking the "Run" button in your IDE or by using the command line. +#### Using IDE -#### If you're running from the command line: -1. **Navigate to the project directory** using the terminal or command prompt. -2. **Compile and run the Kotlin file** with these commands: +1. Open the installed IDE like Android Studio. +2. Create a new Kotlin file. +3. Copy the generated code from API Dash and paste it in the Kotlin file. +4. Run the Kotlin file by clicking the `Run` button in the IDE or by using the command line. + +#### Using command line + +1. Create a new Kotlin file. +2. Copy the generated code from API Dash and paste it in the Kotlin file (`api_test.kt`). +3. Navigate to the project directory using the terminal or command prompt. +4. Compile and run the Kotlin file by executing: ```bash kotlinc api_test.kt -include-runtime -d api_test.jar java -jar api_test.jar ``` - ## PHP (curl) TODO From 2a6dbe598681ccc6e8bfd6664f9f2fa416fe1a05 Mon Sep 17 00:00:00 2001 From: Ashita Prasad Date: Thu, 23 Jan 2025 20:06:42 +0530 Subject: [PATCH 12/12] Update instructions_to_run_generated_code.md --- .../instructions_to_run_generated_code.md | 56 +++++++++++++++---- 1 file changed, 44 insertions(+), 12 deletions(-) diff --git a/doc/user_guide/instructions_to_run_generated_code.md b/doc/user_guide/instructions_to_run_generated_code.md index f1403b02..b195f2bd 100644 --- a/doc/user_guide/instructions_to_run_generated_code.md +++ b/doc/user_guide/instructions_to_run_generated_code.md @@ -116,14 +116,42 @@ Once you have .NET(C#) and `HttpClient` installed, follow these steps to execute ## C# (RestSharp) 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 -Check out the instructions [here](#1-setting-up-the-c-development-environment) for detailed steps on how to set C# Development Environment on macOS, Windows, or Linux. +#### 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:** +#### 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. @@ -131,30 +159,34 @@ Check out the instructions [here](#1-setting-up-the-c-development-environment) f - 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:** +#### Using the CLI + +1. **Create a Project** ```bash dotnet new console -n RestSharpExample cd RestSharpExample ``` -2. **Install the Package:** +2. **Install the Package** ```bash dotnet add package RestSharp ``` -### 3. Execute the generated code: +### 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. ex) prgoram.cs +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 -#### 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: +#### Using the CLI + 1. Open the terminal at the project root directory and run the following command: ```bash dotnet run