Skip to Content
Standalone ModuleThe Workflow

The Workflow

Standalone Mode follows a simple three-step workflow.

Step 1: Import a Collection

Click the Import button in the toolbar to bring in your API collection.

Supported Formats

  • Swagger/OpenAPI: JSON or YAML format.
  • Postman Collection: JSON export from Postman.

Import Methods

From File:

  1. Click Import → From File.
  2. Select your .json file. (YAML import is not yet supported.)
  3. The collection appears in the sidebar.

From URL:

  1. Click Import → From URL.
  2. Paste the API spec URL.
  3. Click Fetch.

Tip: You can import multiple collections. Each collection appears as a separate folder in the sidebar.


Step 2: Send a Request

Selecting an Endpoint

  1. Expand the collection in the left sidebar.
  2. Click any endpoint (e.g., GET /users, POST /login).
  3. The request panel opens on the right.

Configuring the Request

When you select an endpoint, the request is automatically pre-configured with all parameters, headers, and body schema from the collection spec.

Base URL: Automatically set from the collection and displayed at the top of the request panel. Click to edit if needed (e.g., switching from production to staging).

Parameters (if needed):

Query Params: page: 1 limit: 10 Path Params: userId: 123 Headers: Authorization: Bearer <your-token> Content-Type: application/json

Request Body (for POST/PUT/PATCH):

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

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

Sending the Request

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


Step 3: View Response and Interface

After sending a request, two panels are displayed.

Response Panel

Shows the response body along with status and timing information:

{ "id": "user_123", "firstName": "John", "lastName": "Doe", "email": "john@example.com", "createdAt": "2025-02-07T10:30:00Z" }
Status: 200 OK Time: 234ms Size: 156 bytes

Interface Panel

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

interface User { id: string; firstName: string; lastName: string; email: string; createdAt: string; } interface GetUserResponse { data: User; status: number; }

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

Last updated on