Restyx Documentation

Restyx is a free, open-source REST API client. It lets you test APIs, organize requests in collections, manage environments and variables — all from your browser.

Your first request

1. Enter the endpoint URL in the URL field (e.g., https://jsonplaceholder.typicode.com/users)
2. Select the HTTP method (GET, POST, etc.)
3. Click Send or press Ctrl + Enter
4. The response will appear in the right panel

Interface

The interface is divided into three main panels:

• Left sidebar: Collections, folders, and history
• Center panel: Request editor (URL, headers, body, auth)
• Right panel: Server response (JSON, headers, HTML)

Collections

Collections allow you to save and organize your requests so you can reuse them.

Save a request

1. Configure your request (URL, method, headers, etc.)
2. Click the save button or press Ctrl + S
3. Enter a descriptive name
4. Optionally, select a folder

Create folders

Use folders to group related requests (by project, module, etc.):

1. Click the button in the sidebar
2. Enter the folder name
3. Drag and drop requests into the folder

Environments

Environments let you define variables that are automatically replaced in your requests.

Create an environment

1. Click the environment selector in the top bar
2. Click Manage environments
3. Click New environment
4. Add your variables (key/value)

Use variables

Use the {{nombre_variable}} syntax in any field:

• URL: {{base_url}}/users
• Headers: Authorization: Bearer {{token}}
• Body: {"api_key": "{{api_key}}"}

Tabs

Work with multiple requests at the same time using tabs:

• Alt + T - New tab
• Alt + W - Close tab
• Alt + ← / → - Navigate between tabs

History

All sent requests are automatically saved in history:

• Access it from the “History” tab in the sidebar
• Filter by HTTP method or status code
• Search by URL
• Click any entry to load it

Code generation

Export any request to different languages:

• cURL - For terminal/bash
• JavaScript - Using the fetch API
• Python - Using requests
• PHP - Using cURL

Click the button to open the generator.

Authentication: Basic Auth

For APIs that use HTTP Basic Authentication:

1. Go to the Auth tab
2. Select Basic Auth
3. Enter username and password

Authentication: Bearer Token

For APIs that use JWT tokens or other access tokens:

1. Go to the Auth tab
2. Select Bearer Token
3. Enter your token

Authentication: OAuth 2.0

Restyx supports the most common OAuth 2.0 flows:

Authorization Code

For web applications that require user login:

1. Configure Client ID and Client Secret
2. Enter the Authorization URL and Token URL
3. Copy the Callback URL and configure it in your OAuth provider
4. Click “Get Token”
5. Complete login in the pop-up window

Client Credentials

For server-to-server communication:

1. Select “Client Credentials” as the Grant Type
2. Enter Client ID and Client Secret
3. Enter the Token URL
4. Click “Get Token”

Password Grant

For your own (legacy) applications:

1. Select “Password Credentials” as the Grant Type
2. Enter Client ID and Token URL
3. Enter the user’s Username and Password
4. Click “Get Token”

Environment variables

Environment variables are defined manually and persist between sessions:

Dynamic variables

Dynamic variables generate values automatically on each request. They start with $:

Timestamps

Random values

Personal data (fake)

Internet

Business

Tools

Restyx includes advanced tools to improve your workflow.

Request Notes

Document each request with custom notes. Notes are saved with the request and are ideal for:

• Describing the endpoint purpose
• Documenting expected parameters
• Adding usage examples
• Notes about required authentication

How to use notes

1. Open a request or create a new one
2. Go to the Notes tab
3. Write your documentation
4. Notes are saved automatically as you type

Response Diff

Compare responses from the same request to detect changes. This feature is useful for:

• Detecting API changes between versions
• Verifying an endpoint returns expected data
• Debugging inconsistent responses
• Manual regression testing

How to use Diff

1. Execute a request
2. In the JSON tab, click "Save as baseline"
3. Execute the request again
4. Go to the Diff tab to see the differences

Interpreting the Diff

Generate Documentation

Automatically generate documentation for all your collections in Markdown or HTML format.

How to generate documentation

1. Click the button in the top bar
2. Configure the title and description
3. Select what to include (headers, params, body, auth, notes)
4. Choose the format: Markdown or HTML
5. Preview and download

Available formats

Backup & Reminders

Restyx includes a reminder system so you don't lose your collections.

Backup indicator

Next to the export button, you'll see a visual indicator:

Keyboard Shortcuts

General

Requests

Tabs

Import / Export

Export

Export all your collections and environments to a JSON file:

1. Click the button in the top bar
2. A file named restyx-export.json will be downloaded

Import

Import collections and environments from a JSON file:

1. Click the button in the top bar
2. Select the JSON file
3. Collections will be merged with existing ones