Gradle에서 REST API를 호출하는 방법은 무엇인가요?

Q1: Gradle 스크립트 내에서 REST API를 호출하려면 어떤 방법을 사용해야 하나요?
A1: Gradle은 자체적으로 REST API 호출 기능을 제공하지 않기 때문에, 보통 Groovy나 Kotlin DSL을 사용해 외부 HTTP 라이브러리를 활용하거나 Gradle의 내장 기능인 `Exec` 태스크로 커맨드라인 HTTP 클라이언트를 실행하는 방식을 씁니다.

---

Q2: 가장 간단하게 Gradle에서 REST API를 호출하는 방법은?
A2: Gradle 빌드 스크립트 내에서 Groovy의 `URL` 클래스를 사용해 다음과 같이 호출할 수 있습니다.

```groovy
task callRestApi {
doLast {
def url = new URL('https://api.example.com/data')
def conn = url.openConnection()
conn.setRequestMethod('GET')
if (conn.responseCode == 200) {
println(conn.inputStream.text)
} else {
println("Error: " + conn.responseCode)
}
}
}
```

---

Q3: POST 요청이나 헤더 설정, JSON 바디 전송은 어떻게 하나요?
A3: `HttpURLConnection` 객체를 직접 다루어 POST, 헤더 추가, JSON 전송이 가능합니다.

```groovy
task postJson {
doLast {
def url = new URL('https://api.example.com/post')
def conn = url.openConnection()
conn.setRequestMethod('POST')
conn.setRequestProperty('Content-Type', 'application/json')
conn.doOutput = true
def jsonBody = '{"key":"value"}'
conn.outputStream.withWriter('UTF-8') { writer ->
writer.write(jsonBody)
}
if (conn.responseCode == 200) {
println(conn.inputStream.text)
} else {
println("Error: " + conn.responseCode)
}
}
}
```

---

Q4: 외부 라이브러리를 이용해서 Gradle에서 REST API 호출을 할 수 있나요?
A4: 네, `build.gradle`에 라이브러리 의존성을 추가하고 스크립트 내에서 호출할 수 있습니다. 예를 들어 OkHttp 라이브러리를 사용할 때:

```groovy
buildscript {
repositories { mavenCentral() } dependencies { classpath 'com.squareup.okhttp3:okhttp:4.9.3' }
}

task callApiWithOkHttp {
doLast {
def clientClass = Class.forName('okhttp3.OkHttpClient')
def requestBuilderClass = Class.forName('okhttp3.Request$Builder')
def mediaTypeClass = Class.forName('okhttp3.MediaType')

def client = clientClass.newInstance()
def mediaType = mediaTypeClass.getMethod('parse', String).invoke(null, 'application/json; charset=utf-8')

def body = Class.forName('okhttp3.RequestBody')
.getMethod('create', mediaTypeClass, String)
.invoke(null, mediaType, '{"key":"value"}')

def request = requestBuilderClass.newInstance()
.url('https://api.example.com/post')
.post(body)
.build()

def call = client.newCall(request)
def response = call.execute()
println(response.body().string())
}
}
```

단, 복잡하기 때문에 주로 외부 스크립트 혹은 별도 플러그인을 사용하는 것이 좋습니다.

---

Q5: 커맨드라인 툴(curl 등)을 이용해서 Gradle 태스크 내에서 API 호출하려면?
A5: Gradle `Exec` 태스크로 curl을 호출할 수 있습니다.

```groovy
task callApiWithCurl(type: Exec) {
commandLine 'curl', '-X', 'GET', 'https://api.example.com/data'
}
```

curl 등 명령줄 HTTP 클라이언트가 시스템에 설치되어 있어야 하며, 간단한 호출에 적합합니다.

---

Q6: Gradle 플러그인 형태로 REST API 호출 기능을 추가할 수 있나요?
A6: 네, 직접 Gradle 플러그인을 만들어 REST 호출 기능을 캡슐화하거나, 이미 존재하는 HTTP 관련 Gradle 플러그인을 사용할 수 있습니다. 예를 들어 [Gradle HTTP Plugin](https://github.com/Ullink/gradle-http-plugin) 같은 플러그인을 통해 쉽게 API 호출이 가능합니다.

---

Q7: 정리하면 Gradle에서 REST API를 호출하는 권장 방법은 무엇인가요?
A7:
- 간단한 GET/POST 요청: Groovy 내장 `URL` 및 `HttpURLConnection` 사용
- 복잡한 인증/헤더/바디 처리: 외부 HTTP 라이브러리(OkHttp, Apache HTTPClient) 의존성 추가 후 호출
- 임시 또는 단순 호출: `Exec` 태스크로 curl 등 커맨드라인 도구 활용
- 반복적이고 복잡한 호출 관리: 별도 Gradle 플러그인 작성 또는 사용

각 방법은 상황에 맞게 선택하면 됩니다.

Gradle은 주로 빌드 자동화 도구로 사용되지만, Java 애플리케이션 내에서 REST API를 호출하는 데 필요한 라이브러리를 관리하고 설정하는 데 유용합니다.

REST API를 호출하기 위해 Java에서 사용할 수 있는 여러 라이브러리가 있으며, 그 중 가장 인기 있는 라이브러리 중 하나는 `OkHttp`와 `Apache HttpClient`입니다.

이 글에서는 Gradle을 사용하여 REST API를 호출하는 방법을 단계별로 설명하겠습니다.

1. Gradle 프로젝트 설정 먼저, Gradle 프로젝트를 설정해야 합니다.

Gradle을 사용하여 새로운 Java 프로젝트를 생성하려면 다음과 같은 기본 구조를 가질 수 있습니다.

```plaintext my-rest-api-project/ ├── build.gradle └── src/ └── main/ └── java/ └── com/ └── example/ └── Main.java ```

2. build.gradle 파일 설정 `build.gradle` 파일에 필요한 의존성을 추가합니다.

여기서는 `OkHttp`를 사용하여 REST API를 호출하는 예제를 보여드리겠습니다.

```groovy plugins { id 'java' } repositories { mavenCentral() } dependencies { implementation 'com.squareup.okhttp3:okhttp:4.9.3' } ``` 위의 설정에서 `mavenCentral()`을 통해 Maven 중앙 저장소에서 `OkHttp` 라이브러리를 가져옵니다.

`implementation` 키워드를 사용하여 의존성을 추가합니다.



3. REST API 호출 코드 작성 이제 `Main.java` 파일을 작성하여 REST API를 호출하는 코드를 추가합니다.

```java package com.example; import okhttp3.OkHttpClient; import okhttp3.Request; import okhttp3.Response; import java.io.IOException; public class Main { public static void main(String[] args) { OkHttpClient client = new OkHttpClient(); String url = "https://api.example.com/data"; // 호출할 REST API URL Request request = new Request.Builder() .url(url) .build(); try (Response response = client.newCall(request).execute()) { if (!response.isSuccessful()) { throw new IOException("Unexpected code " + response); } // 응답 본문 출력 System.out.println(response.body().string()); } catch (IOException e) { e.printStackTrace(); } } } ``` 위의 코드에서는 `OkHttpClient`를 사용하여 HTTP GET 요청을 보내고, 응답을 받아 출력합니다.

`Request.Builder`를 사용하여 요청을 구성하고, `client.newCall(request).execute()`를 통해 요청을 실행합니다.

응답이 성공적이지 않은 경우 예외를 발생시키고, 성공적인 경우 응답 본문을 출력합니다.



4. Gradle 빌드 및 실행 이제 Gradle을 사용하여 프로젝트를 빌드하고 실행할 수 있습니다.

터미널에서 다음 명령어를 입력합니다.

```bash ./gradlew build ``` 빌드가 성공적으로 완료되면, 다음 명령어로 애플리케이션을 실행할 수 있습니다.

```bash ./gradlew run ```

5. 추가적인 고려사항 - HTTP 메서드 : 위의 예제는 GET 요청을 사용했습니다.

POST, PUT, DELETE 등의 다른 HTTP 메서드를 사용하려면 `Request.Builder`에서 `.post()`, `.put()`, `.delete()` 메서드를 사용하여 요청을 구성할 수 있습니다.

- 헤더 추가 : API 호출 시 인증이나 기타 정보를 위해 헤더를 추가해야 할 경우, `Request.Builder`에서 `.addHeader("Header-Name", "Header-Value")` 메서드를 사용하여 헤더를 추가할 수 있습니다.

- JSON 처리 : REST API의 응답이 JSON 형식인 경우, JSON을 처리하기 위해 `Gson` 또는 `Jackson`과 같은 라이브러리를 추가하여 사용할 수 있습니다.

- 비동기 호출 : `OkHttp`는 비동기 호출을 지원하므로, `enqueue()` 메서드를 사용하여 비동기적으로 API를 호출할 수 있습니다.

결론 Gradle을 사용하여 REST API를 호출하는 방법에 대해 알아보았습니다.

`OkHttp` 라이브러리를 사용하여 간단한 GET 요청을 보내고 응답을 처리하는 방법을 설명했습니다.

이 기본적인 구조를 바탕으로 다양한 REST API를 호출하고, 필요한 기능을 추가하여 확장할 수 있습니다.