UI Response Builder

MaskAPI’s UI Response Builder makes it easy to reshape any JSON response. Available in Mock, Mask, and Database modes right in the Studio.

📘 What Is UI Response Builder?

In the Response Builder, you can:

• Rename any output key
• Add new fields from existing data
• Remap which original field feeds each output
• Nest or flatten objects and arrays
• Preview every change instantly

🧩 How to Use the Response Builder

1. Select your project.
2. Go to the Studio tab.
3. Switch the mode dropdown to Mock (or Mask/Database).
4. Click the Configs tab.
5. Toggle Response Builder on.
6. Click Run Mask to initialize the builder data.
7. In the Response Builder top-bar, click Fill Builder.
8. Make visual edits:
   • Rename: click a Name cell and type a new key.
   • Add: hit the green ➕, choose Type and Source.
   • Remap: in Source, pick a same‑type field.
   • Remove: click the red ⛔ to delete any field (except an array’s ITEMS).
   • Restructure: add or remove object/array nodes to nest or flatten.
   • Arrays: under each array’s ITEMS node, configure fields for every entry.
9. After each change, click Run Mask to refresh the preview.
10. Enter your API Route name.
11. Click Launch to deploy your endpoint.

🔄 Reset Response Builder

To reset all edits, click the red Reset & Refresh button in the Response Builder top-bar.

🛠️ Before & After Example

Before (raw response):

{
  "id": 1,
  "name": "Alice",
  "company": { "name": "Acme Corp" }
}

After (renamed & flattened):

{
  "employeeId": 1,
  "fullName": "Alice",
  "companyName": "Acme Corp"
}