Master API Testing Directly in JetBrains IDE with the Built‑in HTTP Client

Introduction

Testing API endpoints has become a routine part of modern development. JetBrains IDEs embed an HTTP client that lets you issue requests and inspect responses without switching to external tools such as Postman or Insomnia, supporting simple GET calls to complex GraphQL scenarios.

Core Overview of the HTTP Client

The client is an embedded tool designed for developers. You write request scripts in files with .http or .rest extensions and execute them with a single click from the IDE UI. It handles RESTful services, WebSocket communication, and GraphQL queries seamlessly.

Key Advantages

Scriptable Requests : Define and run requests in plain‑text files, with support for comments and grouping.

Multi‑Protocol Support : Handles HTTP/HTTPS, GraphQL and WebSocket.

Flexible Configuration : Customise headers, query parameters, body data, and file uploads.

Authentication & Security : Built‑in Bearer Token, Basic Auth and other mechanisms.

Environment Management : Switch between environments (e.g., dev/prod) using variables and environment files.

History Tracking : Automatically saves execution records for reuse and troubleshooting.

Syntax Basics

The scripting syntax is concise, similar to cURL but more readable. The core structure consists of an optional comment line, the request line, optional headers, a blank line, and an optional body.

### [Open Source Tech Stack] Optional comment
METHOD URL?query=params
Header: Value
Another-Header: Value


Optional request body

METHOD

: HTTP verb such as GET, POST, etc. URL: Target endpoint, optionally with query string. Header: Key‑value pairs; a blank line separates headers from the body.

Practical Examples

Basic GET Request: Retrieve Resource

### [Open Source Tech Stack] Fetch post data from public API
GET https://jsonplaceholder.typicode.com/posts/42
Accept: application/json

This GET call fetches the post with ID 42. The Accept header requests a JSON response. The IDE displays the response body, status code and timing.

POST Request: Submit JSON Data

### [Open Source Tech Stack] Create a new post
POST https://jsonplaceholder.typicode.com/posts
Content-Type: application/json

{
  "title": "Test New Article",
  "body": "Article body content",
  "userId": 999
}

The POST creates a resource. The Content-Type header declares JSON format, and the IDE highlights and validates the JSON payload.

PUT Request: Update Existing Resource

### [Open Source Tech Stack] Update post information
PUT https://jsonplaceholder.typicode.com/posts/42
Content-Type: application/json

{
  "id": 42,
  "title": "Modified Title",
  "body": "Updated content",
  "userId": 999
}

PUT is used for full or partial updates. Ensure the ID in the payload matches the URL to avoid conflicts.

DELETE Request: Remove Resource

### Delete specific post
DELETE https://jsonplaceholder.typicode.com/posts/42

DELETE requires no body; the IDE reports a successful status even though the response body is typically empty.

Variable Injection: Avoid Hard‑Coding

### Use variables to build URL dynamically
GET {{host}}/posts/42
Accept: application/json

###

@baseUrl = https://jsonplaceholder.typicode.com

Define variables with @ (e.g., baseUrl) and reference them using {{ }}. The IDE provides autocomplete and substitution.

Environment Variable Management

Create an http-client.env.json file at the project root to store configurations for different environments:

{
  "dev": {
    "host": "https://dev-api.example.com",
    "token": "dev-bearer-token-xyz"
  },
  "prod": {
    "host": "https://api.example.com",
    "token": "prod-bearer-token-abc"
  }
}

Reference the variables in a .http file:

### Environment‑driven request
GET {{host}}/posts
Authorization: Bearer {{token}}

Select the desired environment from the IDE toolbar dropdown; variables update instantly.

Authentication Example: Bearer Token

GET https://secure-api.example.com/user/profile
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Add the Authorization header directly; the IDE can store the token securely.

Basic Authentication (Basic Auth)

GET https://private-api.example.com/data
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=  # Base64‑encoded username:password

Encode username:password and embed it in the header for simple scenarios.

Form Submission

POST https://api.example.com/auth/login
Content-Type: application/x-www-form-urlencoded

username=testuser&password=secret123

Send URL‑encoded key‑value pairs to simulate a browser form.

File Upload

POST https://upload-api.example.com/files
Content-Type: multipart/form-data; boundary=----formdata

------formdata
Content-Disposition: form-data; name="document"; filename="report.pdf"
Content-Type: application/pdf

< ./path/to/report.pdf
------formdata--

Use the < syntax to reference a local file; the IDE handles multipart boundaries automatically.

GraphQL Query

### Execute GraphQL operation
POST https://graphql.example.com
Content-Type: application/json

{
  "query": "query GetUser($id: ID!) { user(id: $id) { name email posts } }",
  "variables": { "id": "42" }
}

Package the query string and variables as JSON; the client supports introspection and mutations.

WebSocket Connection

CONNECT ws://ws.example.com/chat
Sec-WebSocket-Key: random-key

Use CONNECT to start a WebSocket session; the IDE opens a live console showing the message flow.

Advanced Tips

Request Grouping : Separate multiple requests with ### for better organization.

Response Handling : After execution, view pretty‑printed JSON, XML parsing, or image previews.

Script Automation : Integrate requests into Run Configurations for CI/CD testing.

Debugging Tricks : Enable the “Response Filter” to inspect slow queries or error logs.

Although simple, this tool covers roughly 90 % of typical API development needs. Combine it with the IDE’s code completion for a fast learning curve, and feel free to ask specific scenario questions.