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)