apidash/doc/user_guide/instructions_to_run_generated_code.md

How to Run Generated Code for a Programming Language

Choose your programming language/library from the list provided below to learn more how you can execute them:

• cURL
• C (libcurl)
• C# (HttpClient)
• C# (RestSharp)
• Dart (http)
• Dart (dio)
• Go (net/http)
• JavaScript (axios)
• JavaScript (fetch)
• node.js (JavaScript, axios)
• node.js (JavaScript, fetch)
• Java (asynchttpclient)
• Java (HttpClient)
• Java (okhttp3)
• Java (Unirest)
• Julia (HTTP)
• Kotlin (okhttp3)
• PHP (curl)
• PHP (guzzle)
• PHP (HTTPlug)
• Python (requests)
• Python (http.client)
• Ruby (faraday)
• Ruby (net/http)
• Rust (hyper)
• Rust (reqwest)
• Rust (ureq)
• Rust (Actix Client)
• Swift (URLSession)
• Swift (Alamofire)

Please raise a GitHub issue in case any instruction is not clear or if it is not working.

cURL

TODO

C (libcurl)

TODO

C# (HttpClient)

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.
   • Download and install the latest .NET SDK for macOS.
2. Verify Installation:
   • Open the terminal and run the following command to verify the installation:

     dotnet --version
     

Linux:

1. Install .NET SDK:
   • Run the following commands based on your distribution:
     • For Ubuntu/Debian-based systems:

       sudo apt update
       sudo apt install dotnet-sdk-7.0
       

     • For Fedora/CentOS-based systems:

       sudo dnf install dotnet-sdk-7.0
       

2. Verify Installation:
   • Open the terminal and run the following command to verify the installation:

     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:

   dotnet new console -n HttpClientExample
   cd HttpClientExample
   

2. Install the Package (if necessary):

   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:

   dotnet run
   

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

macOS and Windows

1. Install .NET SDK
   • Visit the official .NET download page.
   • Download and install the latest .NET SDK for macOS.
2. Verify Installation
   • Open the terminal and run the following command to verify the installation:

     dotnet --version
     

Linux

1. Install .NET SDK
   • Run the following commands based on your distribution:
     • For Ubuntu/Debian-based systems:

       sudo apt update
       sudo apt install dotnet-sdk-7.0
       

     • For Fedora/CentOS-based systems:

       sudo dnf install dotnet-sdk-7.0
       

2. Verify Installation
   • Open the terminal and run the following command to verify the installation:

     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

   dotnet new console -n RestSharpExample
   cd RestSharpExample
   

2. Install the Package

   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:

   dotnet run
   

Dart (http)

Here are the detailed instructions for running the generated API Dash code in Dart (using http) for macOS, Windows, and Linux:

1. Install Dart

• Visit the official Dart Installation Guide for step-by-step installation instructions for macOS, Windows, and Linux.

2. Add the http Package

• Add the http package as a dependency under the dependencies section of the pubspec.yaml file:

  dependencies:
    http: ^1.2.2
  

• Run the following command to fetch the dependency:

  dart pub get
  

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.

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:

   dart run api_test.dart
   

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

• Visit the official Dart Installation Guide for step-by-step installation instructions for macOS, Windows, and Linux.

2. Add the dio Package

• Add the dio package as a dependency under the dependencies section of the pubspec.yaml file:

  dependencies:
    dio: ^5.7.0
  

• Run the following command to fetch the dependency:

  dart pub get
  

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.

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:

   dart run api_test.dart
   

Go (net/http)

1. Install Go compiler

• Windows and MacOS: check out the official source
• Linux: Install from your distro's package manager.

Verify if go is installed:

go version

2. Create a project

go mod init example.com/api

3. Run the generated code

• Paste the generated code into main.go.
• Build and run by go run main.go.

JavaScript (axios)

The generated api code can be run in browser by using the code in an html file as demonstrated below:

1. Create the html file with generated code

Create a new file index.html

<!DOCTYPE html>
<html>
<head>
    <title>Axios Example</title>
    <script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
</head>
<body>
    <script>
        // Paste your API Dash generated code here !!
    </script>
</body>
</html>

Make sure to paste the generated js code from api dash under the <script> tag.

2. Test with Browser Developer Tools

Open the index.html file in a modern browser and open devtools.

• Chrome: Right-click the page and select "Inspect" or press Ctrl+Shift+I (Windows/Linux) or Cmd+Option+I (macOS).

• Firefox: Right-click the page and select "Inspect Element" or press Ctrl+Shift+I (Windows/Linux) or Cmd+Option+I (macOS).

• Edge: Right-click the page and select "Inspect" or press F12 or Ctrl+Shift+I.

Navigate to network tab and refresh the page to see the requests and network activity.

JavaScript (fetch)

The generated api code can be run in browser by using the code in an html file as demonstrated below:

1. Create the html file with generated code

Create a new file index.html

<!DOCTYPE html>
<html>
<head>
    <title>Fetch Example</title>
</head>
<body>
    <script>
        // Paste your API Dash generated code here !!
    </script>
</body>
</html>

Make sure to paste the generated js code from api dash under the <script> tag.

2. Test with Browser Developer Tools

Open the index.html file in a modern browser and open devtools.

• Chrome: Right-click the page and select "Inspect" or press Ctrl+Shift+I (Windows/Linux) or Cmd+Option+I (macOS).

• Firefox: Right-click the page and select "Inspect Element" or press Ctrl+Shift+I (Windows/Linux) or Cmd+Option+I (macOS).

• Edge: Right-click the page and select "Inspect" or press F12 or Ctrl+Shift+I.

Navigate to network tab and refresh the page to see the requests and network activity.

node.js (JavaScript, axios)

1.Install Node.js:

Ensure Node.js and npm are installed. Verify by running:

node --version
npm --version

If not, download from Node.js Official Website.

Initialize a new Node.js project:

npm init -y

Install Axios:

npm install axios

2.Set Up a New Project:

Create a new project directory:

mkdir node-axios-example
cd node-axios-example

Initialize the project:

npm init -y

3.Create and Run the Code:

Save the generated code in a file(e.g., app.js).

Run the code:

node app.js

node.js (JavaScript, fetch)

1. Install Node.js:

Ensure Node.js and npm are installed. Verify by running:

node --version
npm --version

If not, download from Node.js Official Website.

Initialize a new Node.js project:

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:

npm install node-fetch

2. Set Up a New Project:

Create a project directory:

mkdir node-fetch-example
cd node-fetch-example

Initialize the project:

npm init -y

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:

const fetch = require('node-fetch');

Run the file:

node app.js

Java (asynchttpclient)

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 and follow the instructions to install the latest JDK on macOS, Windows, or Linux.

After installation, verify it by running:

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:

    <dependencies>
      <dependency>
          <groupId>org.asynchttpclient</groupId>
          <artifactId>async-http-client</artifactId>
          <version>3.0.1</version>
      </dependency>
    </dependencies>
   

2. Save the file and run:

   mvn install
   

Using Gradle

1. Add the following line to the dependencies section in your build.gradle file:

    implementation 'org.asynchttpclient:async-http-client:3.0.1'
   

2. Run the following command to fetch the dependency:

   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:

   javac ApiTest.java
   

3. Run the compiled program:

   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

To run Java code, you need to have Java Development Kit (JDK) installed on your system.

• Visit the official Java Downloads Page and follow the instructions to install the latest JDK on macOS, Windows, or Linux.

After installation, verify it by running:

java -version

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:

java -version

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:

   javac ApiTest.java
   

3. Run the compiled program:

   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

To run Java code, you need to have Java Development Kit (JDK) installed on your system.

• Visit the official Java Downloads Page and follow the instructions to install the latest JDK on macOS, Windows, or Linux.

After installation, verify it by running:

java -version

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:

   <dependency>
       <groupId>com.squareup.okhttp3</groupId>
       <artifactId>okhttp</artifactId>
       <version>4.12.0</version>
   </dependency>
   

2. Save the file and run:

   mvn install
   

Using Gradle

1. Add the following line to the dependencies section in your build.gradle file:

   implementation 'com.squareup.okhttp3:okhttp:4.12.0'
   

2. Run the following command to fetch the dependency:

   gradle build
   

3. Run the Generated 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:

   javac ApiTest.java
   

3. Run the compiled program:

   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

To run Java code, you need to have Java Development Kit (JDK) installed on your system.

• Visit the official Java Downloads Page and follow the instructions to install the latest JDK on macOS, Windows, or Linux.

After installation, verify it by running:

java -version

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:

   <dependency>
       <groupId>com.konghq</groupId>
       <artifactId>unirest-java</artifactId>
       <version>3.14.1</version>
   </dependency>
   

2. Save the file and run:

   mvn install
   

Using Gradle

1. Add the following line to the dependencies section in your build.gradle file:

   implementation 'com.konghq:unirest-java:3.14.1'
   

2. Run the following command to fetch the dependency:

   gradle build
   

3. Run the Generated 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:

   javac ApiTest.java
   

3. Run the compiled program:

   java ApiTest
   

Julia (HTTP)

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 by following the below instructions:

• Go to Kotlin Installation Guide for detailed steps.
• Kotlin is also included in IntelliJ IDEA and Android Studio. You can also download and install one of these IDEs to start using Kotlin.

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:

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:

Using IDE

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:

kotlinc api_test.kt -include-runtime -d api_test.jar
java -jar api_test.jar

PHP (curl)

Here are the detailed instructions for running the generated API Dash code in PHP (using curl) for macOS, Windows, and Linux:

1. Install and set PHP:

Before starting out, we need to install PHP in our system.

macOS:

• Go to the official PHP website: https://www.php.net/manual/en/install.macosx.php
• Follow the installation instructions.

Windows:

• Go to the official PHP website: https://www.php.net/manual/en/install.windows.php
• Follow the installation instructions.

Linux:

The installation process depends on your Linux distribution. Use the appropriate command below:

• Ubuntu/Debian

sudo apt update
sudo apt install php php-cli php-curl php-mbstring php-xml php-zip -y

• Arch Linux / Manjaro

sudo pacman -S php php-apache php-cgi php-curl php-mbstring php-xml php-zip

• Fedora / CentOS

- sudo dnf install php php-cli php-curl php-mbstring php-xml php-zip -y

• OpenSUSE

sudo zypper install php php-cli php-curl php-mbstring php-xml php-zip

✅ Finally, check that everything works correctly pasting this command in your terminal

php --version

2. Check cURL

cURL is usually enabled by default. To check if it's active, run:

php -m | grep curl

and check if it returns curl as output

If curl is disabled

1. Open the php.ini configuration file. You can find its location by running:

php --ini

2. Open the file in a text editor/IDE
3. Find this line

;extension=curl

4. Remove the semicolon (;) at the beginning to enable it:

extension=curl

5. Save and restart php by using

sudo systemctl restart apache2  # For Apache
sudo systemctl restart php8.2-fpm  # For PHP-FPM (Nginx)

3. Execute the generated code:

Once you have everything needed 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. Create a php file ( ex. request.php ) ✍️ (Visual Studio, VS Code or any other text editor).
3. Copy and paste the generated API code 📋 from API Dash into the request.php file.

In Visual Studio:

1. Click the Start Debugging (F5) button from the top menu to run the project.
2. The terminal will display the API response.

Using the CLI:

1. Open the terminal at the project root directory and run the file you've created:

php filename.php

2. The terminal will display the API response.

PHP (guzzle)

TODO

PHP (HTTPlug)

TODO

Python (requests)

Here are the detailed instructions for running the generated API Dash code in Python (using requests) for macOS, Windows, and Linux:

1. Install Python:

macOS:

• Go to the official Python website: https://www.python.org/downloads/macos/
• Download the latest version for macOS and follow the installation instructions.

Windows:

• Go to the official Python website: https://www.python.org/downloads/
• Download the latest version for Windows and run the installer. During installation, make sure to check the box that says "Add Python to PATH."

Linux:

• Most Linux distributions come with Python pre-installed. To check if Python is already installed, open the terminal and type:

python3 --version

• If it's not installed, you can install it via your package manager:

  • On Ubuntu/Debian-based systems:

    sudo apt update
    sudo apt install python3
    

  • On Fedora/CentOS-based systems:

    sudo dnf install python3
    

2. Install the requests library:

macOS and Linux:

Open the terminal and type the following command to install the requests library using pip:

pip3 install requests

Windows:

Open Command Prompt (or PowerShell) and type the following command to install the requests library using pip:

pip install requests

3. Execute the generated code:

Once you have Python and requests installed, follow these steps to execute the generated code:

1. Open a text editor ✍️ (like Notepad on Windows, TextEdit on macOS, or any code editor like Visual Studio Code).
2. Copy the generated code 📋 from API Dash.
3. Paste the code into the text editor 🔄.
4. Save the file 💾 with a .py extension, such as api_test.py.

This makes the steps a little more visual and fun!

macOS and Linux:

1. Open the Terminal.
2. Navigate to the directory where you saved the .py file. For example:

cd /path/to/your/file

3. Run the Python script by typing the following command:

python3 api_test.py

Windows:

1. Open Command Prompt (or PowerShell).
2. Navigate to the directory where you saved the .py file. For example:

cd C:\path\to\your\file

3. Run the Python script by typing the following command:

python api_test.py

Python (http.client)

Here are the detailed instructions for running the generated API Dash code in Python using http.client:

1. Install Python:

Check out the instructions here for detailed steps on how to install Python on macOS, Windows, or Linux.

2. http.client is a built-in library:

Unlike other Python libraries (like requests), http.client is part of Python's standard library. You can directly use it without any additional installation steps.

3. Execute the generated code:

Check out the instructions here for detailed steps on how to run the code.

Ruby (faraday)

TODO

Ruby (net/http)

TODO

Rust (hyper)

TODO

Rust (reqwest)

1. Download and Install Rust:

Windows

1. Download and install rustup from Rustup Official Site.
2. Run the installer (rustup-init.exe) and follow the instructions.
3. Restart your terminal (Command Prompt or PowerShell).
4. Verify the installation:

   rustc --version
   cargo --version
   

MacOS/Linux

1. Run the following in your terminal:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   

   then follow the on-screen instructions.

2. Restart the terminal and verify:

   rustc --version
   cargo --version
   

Note: If you prefer not to use rustup for some reason, please see the Other Rust Installation Methods page for more options.

2. Set Up a New Rust Project

1. Open a terminal and create a new Rust project:

   cargo new reqwest-demo
   

2. Navigate into the project directory:

   cd reqwest-demo
   

   or open this project directory in your preferred code editor.

3. Add Necessary Dependencies

Run the following command to add dependencies:

cargo add reqwest --features blocking,json
cargo add tokio --features full

• "blocking": Enables synchronous requests.
• "json": Allows JSON parsing.
• "tokio": Needed for asynchronous execution.

Run the following command to fetch dependencies:

cargo build

4. Execute code

1. Copy the generated code from API Dash.
2. Paste the code into your project's src/main.rs directory

Run the generated code:

cargo run

Rust (ureq)

1. Download and Install Rust:

Windows

1. Download and install rustup from Rustup Official Site.
2. Run the installer (rustup-init.exe) and follow the instructions.
3. Restart your terminal (Command Prompt or PowerShell).
4. Verify the installation:

   rustc --version
   cargo --version
   

MacOS/Linux

1. Run the following in your terminal:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   

   then follow the on-screen instructions.

2. Restart the terminal and verify:

   rustc --version
   cargo --version
   

Note: If you prefer not to use rustup for some reason, please see the Other Rust Installation Methods page for more options.

2. Set Up a New Rust Project

1. Open a terminal and create a new Rust project:

   cargo new ureq-demo
   

2. Navigate into the project directory:

   cd ureq-demo
   

   or open this project directory in your preferred code editor.

3. Add ureq Dependency

Run the following command to add dependencies:

cargo add ureq

Run the following command to fetch dependencies:

cargo build

4. Execute code

1. Copy the generated code from API Dash.
2. Paste the code into your project's src/main.rs directory

Run the generated code:

cargo run

Rust (Actix Client)

TODO

Swift (URLSession)

Set Up the Environment

MacBook (macOS)

Verify Swift :

swift --version

Linux(Multipartformdata is not supported)

Download Swift for Linux (e.g., Ubuntu) from Swift.org.

tar xzf filename
export PATH=$PWD/filename/usr/bin:$PATH

Verify:

swift --version

Install Dependencies:

sudo apt-get update
sudo apt-get install clang libicu-dev libcurl4-openssl-dev

Create a Project:

mkdir URLSessionDemo
cd URLSessionDemo
swift package init --type executable

Run the Code

Ensure main.swift is in Sources/URLSessionDemo.

Run:

swift run

Swift (Alamofire)

Set Up the Environment

MacBook (macOS)

Verify Swift :

swift --version

Linux (Multipartformdata is not supported)

Download Swift for Linux (e.g., Ubuntu) from Swift.org.

tar xzf filename
export PATH=$PWD/filename/usr/bin:$PATH

Verify:

swift --version

Install Dependencies for swift:

sudo apt-get update
sudo apt-get install clang libicu-dev libcurl4-openssl-dev

Create a Project:

mkdir URLSessionDemo
cd URLSessionDemo
swift package init --type executable

Adding alamofire

open package.swift and add following dependencies and target(replace project-name with your project name)

 dependencies: [
        .package(url: "https://github.com/Alamofire/Alamofire", from: "5.6.4")
    ],
 targets: [
        .executableTarget(
            name: "project-name",
            dependencies: [
                "Alamofire" 
            ]
        )
    ]

Run the Code

Ensure main.swift is in Sources/URLSessionDemo.

Run:

swift run