Merge pull request #537 from AffanShaikhsurab/patch-7

Add platform-specific instructions for running API Dash-generated Java
This commit is contained in:
Ashita Prasad
2025-01-21 20:41:55 +05:30
committed by GitHub

View File

@ -307,19 +307,225 @@ node app.js
## 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
<dependencies>
<dependency>
<groupId>org.asynchttpclient</groupId>
<artifactId>async-http-client</artifactId>
<version>3.0.1</version>
</dependency>
</dependencies>
```
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 '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
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
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
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)
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
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
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
<dependency>
<groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId>
<version>4.12.0</version>
</dependency>
```
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
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)
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
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
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
<dependency>
<groupId>com.konghq</groupId>
<artifactId>unirest-java</artifactId>
<version>3.14.1</version>
</dependency>
```
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
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)