httpClient

HTTP client for making requests in scripts. Supports making HTTP calls to external services during API export or other operations.

Usage

http.call.before=groovy:'''
def response = httpClient.get("http://auth-server/token")
it.header("Authorization", "Bearer " + response.body())
'''

Methods

Method	Return Type	Description
httpClient.get(url)	HttpResponse	Send a GET request
httpClient.post(url, body)	HttpResponse	Send a POST request
httpClient.put(url, body)	HttpResponse	Send a PUT request
httpClient.delete(url)	HttpResponse	Send a DELETE request

Response Object

The response object provides access to:

Property/Method	Return Type	Description
response.code()	Int	HTTP status code
response.body()	String	Response body as string
response.headers()	Map<String, String>	Response headers

Examples

GET Request

http.call.before=groovy:'''
def response = httpClient.get("http://config-server/api/config")
if (response.code() == 200) {
    def config = new JsonSlurper().parseText(response.body())
    logger.info("Config loaded: " + config)
}
'''

POST Request with JSON

export.before=groovy:'''
import groovy.json.JsonOutput

def data = [
    project: "my-project",
    apis: []
]

def json = JsonOutput.toJson(data)
def response = httpClient.post("http://api-server/sync", json)
logger.info("Sync result: " + response.code())
'''

Authentication

http.call.before=groovy:'''
def token = session.get("auth_token")
if (!token) {
    def loginResponse = httpClient.post("http://auth-server/login", [
        username: config.get("auth.username"),
        password: config.get("auth.password")
    ])
    
    if (loginResponse.code() == 200) {
        def result = new JsonSlurper().parseText(loginResponse.body())
        token = result.token
        session.set("auth_token", token)
    }
}

if (token) {
    it.header("Authorization", "Bearer " + token)
}
'''

Error Handling

http.call.after=groovy:'''
def code = it.response().code()
if (code >= 400) {
    logger.error("HTTP error: " + code)
    logger.error("Response: " + it.response().body())
}
'''

Conditional Request

http.call.before=groovy:'''
def apiUrl = config.get("api.url")
if (apiUrl) {
    def healthCheck = httpClient.get(apiUrl + "/health")
    if (healthCheck.code() != 200) {
        logger.warn("API server health check failed")
    }
}
'''

Notes

• HTTP requests are synchronous - they block until completion
• Use session or localStorage to cache responses when appropriate
• Handle errors gracefully with status code checks
• The httpClient is configured based on IDE settings (Apache HttpClient, Java URLConnection, or IntelliJ HTTP Client)

See Also

• session - Session-level storage for caching
• localStorage - Persistent storage for caching
• config - Configuration access
• logger - Logging utility