Skip to Content
Test ModuleThe Workflow

The Workflow

Text Mode follows a simple create-and-test workflow.

Step 1: Create a Collection

Collections help you organize related requests together.

  1. Click + New Collection.
  2. Enter a name (e.g., “User API Testing”, “Payment Endpoints”).
  3. Click Create. The collection appears in the sidebar.

Tip: Create separate collections for different APIs or features to keep your workspace organized.


Step 2: Create a Request

  1. Select a collection from the sidebar.
  2. Click + New Request.
  3. Enter a name (e.g., “Get User List”, “Create Payment”).
  4. The request panel opens.

Step 3: Configure the Request

HTTP Method: Choose from the dropdown — GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS.

URL: Type or paste the full endpoint URL:

https://api.yourapp.com/users

Query Parameters (optional):

Key | Value ---------|------- page | 1 limit | 10 search | john

Headers:

Key | Value ----------------|------------------------- Content-Type | application/json Authorization | Bearer eyJhbGc...

Request Body (for POST, PUT, PATCH):

{ "firstName": "John", "lastName": "Doe", "email": "john@example.com", "role": "admin" }

Authentication: Click the Auth tab, select Bearer Token, and enter your token. (Bearer Token is currently the only supported auth type.)


Step 4: Send the Request

Click Send. Reex API Builder executes the request and displays the response in real-time.


Step 5: View Response and Interface

After sending, two panels are displayed.

Response Panel

Shows the response body along with status and timing information:

{ "data": [ { "id": "user_123", "firstName": "John", "email": "john@example.com" } ], "meta": { "page": 1, "total": 50 } }
Status: 200 OK Time: 234ms Size: 487 bytes

Interface Panel

Reex API Builder automatically generates a TypeScript interface from the response:

interface User { id: string; firstName: string; email: string; } interface Meta { page: number; total: number; } interface GetUsersResponse { data: User[]; meta: Meta; }

Click the Copy icon to copy the interface and paste it directly into your project.

Note: Interfaces update automatically each time you send a request with a new or different response structure.

Last updated on