Tutorial section for Mock Servers docs by ganesh-bruno · Pull Request #181 · usebruno/bruno-docs

ganesh-bruno · 2026-08-25T07:01:48Z

Update bru.disableParsingResponseJson() method with req.disableParsingResponseJson() with example
Create Tutorial section under mock servers with (collection and openAPI) as separate document

mintlify · 2026-08-25T07:01:51Z

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
bruno-docs-main	🟢 Ready	View Preview	Aug 25, 2026, 7:03 AM

anthonyd-bruno

I think we should call Mock Tutorial -> Getting Started
Mock with Response Examples -> Mock Servers from Collection
Mock with OpenAPI -> Mock Servers from OpenAPI

anthonyd-bruno · 2026-08-25T14:25:26Z

+description: "Walk through saving collection response examples, creating a mock server from them, syncing, adding rules, and serving the mock locally."
+---
+
+Saved [response examples](/send-requests/res-data-cookies/response-examples) are snapshots of how an API behaves: success payloads, validation errors, empty lists, and other states you care about. Once they live on a request, you can document those cases, share them with the team, and with Mock Servers, serve them on `localhost` so a frontend or integration test does not need the real backend.


Suggested change

Saved [response examples](/send-requests/res-data-cookies/response-examples) are snapshots of how an API behaves: success payloads, validation errors, empty lists, and other states you care about. Once they live on a request, you can document those cases, share them with the team, and with Mock Servers, serve them on `localhost` so a frontend or integration test does not need the real backend.

[Response examples](/send-requests/res-data-cookies/response-examples) are snapshots of how an API behaves with success payloads, validation errors, empty lists, and other states you care about. Once they've been saved as an example, you can document those cases, share them with the team, and with Mock Servers, serve them locally so a frontend or integration test can immediately hit the endpoints without needing the real backend to be up and available.

anthonyd-bruno · 2026-08-25T14:31:53Z

+Saved [response examples](/send-requests/res-data-cookies/response-examples) are snapshots of how an API behaves: success payloads, validation errors, empty lists, and other states you care about. Once they live on a request, you can document those cases, share them with the team, and with Mock Servers, serve them on `localhost` so a frontend or integration test does not need the real backend.
+
+<Warning>
+  Mock Servers are in **Beta**. Open **Preferences → Beta** and turn on **Mock Server**. The **Mock Servers** section appears in the sidebar only after you opt in.


Suggested change

Mock Servers are in **Beta**. Open **Preferences → Beta** and turn on **Mock Server**. The **Mock Servers** section appears in the sidebar only after you opt in.

Mock Servers are in **Beta**. Open **Preferences → Beta** to turn on the **Mock Server** feature. The **Mock Servers** section appears in the sidebar only after you opt in.

anthonyd-bruno · 2026-08-25T14:34:08Z

+  Mock Servers are in **Beta**. Open **Preferences → Beta** and turn on **Mock Server**. The **Mock Servers** section appears in the sidebar only after you opt in.
+</Warning>
+
+## Create response examples


This shows how to create a response example "from scratch". We should also show how to save a response as an example.

anthonyd-bruno · 2026-08-25T14:37:36Z

+  Create at least one example per route you plan to mock. Multiple examples on the same method and path become alternative mock responses once you add [rules](/mock-servers/run-mock-server#rules).
+</Tip>
+
+## Create a mock from collection examples


These look like sequential steps, so we should label them as such.

Create or save response examples

Create a Mock Server tied to a Collection

Sync with examples
...

anthonyd-bruno · 2026-08-25T14:38:47Z

+
+![Create Mock Server dialog with Collection as the source](/images/screenshots/v4/mock-severs/tutorial-create-mock-server.webp)
+
+Bruno opens the mock [dashboard](/mock-servers/run-mock-server#dashboard-interface-walkthrough). The server is not running yet — you still need to sync examples, then start it.


This is a really good landmark guide. Nice!

anthonyd-bruno · 2026-08-25T14:58:37Z

+| Match | Behavior |
+|-------|----------|
+| **All rules AND** (default) | Every condition must pass. |
+| **Any rule OR** | One passing condition is enough. |


anthonyd-bruno · 2026-08-25T14:59:47Z

+
+![Rules editor with Save, Try, and Try Result](/images/screenshots/v4/mock-severs/tutorial-collection-examples-rules.webp)
+
+With the mock server running, click **Try** next to the response URL to send the demo request. Open the **Try Result** tab on the right: it shows only the body and headers you defined in **Expected** and **Headers**. Anything not set there will not appear in Try Result.


I would move the start server stuff to just above here.

This is confusing for me, I would consider rephrasing.

"Open the Try Result tab on the right: it shows only the body and headers you defined in Expected and Headers. Anything not set there will not appear in Try Result."

anthonyd-bruno · 2026-08-25T15:05:56Z

+
+With the mock server running, click **Try** next to the response URL to send the demo request. Open the **Try Result** tab on the right: it shows only the body and headers you defined in **Expected** and **Headers**. Anything not set there will not appear in Try Result.
+
+**Demo Request** is generated from the rules you defined. It shows a sample request that would select this response, so you can copy it into a client or use **Try** while the server is running.


Suggested change

**Demo Request** is generated from the rules you defined. It shows a sample request that would select this response, so you can copy it into a client or use **Try** while the server is running.

**Demo Request** is generated from the rules you defined. It shows a sample request that would select this response.

The ending was a little confusing for me.

anthonyd-bruno · 2026-08-25T18:39:13Z

+
+### Right section: expected body and headers
+
+Use this side to define **what** the mock returns: the **Expected** body and **Headers**, plus the status code.


Suggested change

Use this side to define **what** the mock returns: the **Expected** body and **Headers**, plus the status code.

Use this side to see **what** the mock returns: the **Expected** body and **Headers**, plus the status code.

anthonyd-bruno · 2026-08-25T18:41:14Z

+
+The body can be JSON, HTML, text, or XML. Headers are independent of body type, set `Content-Type` and any other headers the client should see.
+
+**Try Result** shows the response body and headers from **Expected** and **Headers** after you click **Try**. Only those values appear — the tab does not invent extra fields.


Suggested change

**Try Result** shows the response body and headers from **Expected** and **Headers** after you click **Try**. Only those values appear — the tab does not invent extra fields.

**Try Result** shows the response body and headers from **Expected** and **Headers** after you click **Try** (with the server running).

update disable parsing method to req from bru

b7961bd

mintlify Bot deployed to staging August 25, 2026 07:03 View deployment

mock-tutorial: add mock tutorial section

9e02892

mintlify Bot deployed to staging August 25, 2026 13:06 View deployment

ganesh-bruno requested a review from anthonyd-bruno August 25, 2026 13:56

anthonyd-bruno reviewed Aug 25, 2026

View reviewed changes

Navigation Menu

Uh oh!

Tutorial section for Mock Servers docs - #181

Tutorial section for Mock Servers docs #181
ganesh-bruno wants to merge 2 commits into
mainfrom
tutor/mock-server

ganesh-bruno commented Aug 25, 2026

Uh oh!

mintlify Bot commented Aug 25, 2026 •

edited

Loading

Uh oh!

anthonyd-bruno left a comment

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

anthonyd-bruno Aug 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	Mock Servers are in Beta. Open Preferences → Beta and turn on Mock Server. The Mock Servers section appears in the sidebar only after you opt in.
	Mock Servers are in Beta. Open Preferences → Beta to turn on the Mock Server feature. The Mock Servers section appears in the sidebar only after you opt in.


		![Create Mock Server dialog with Collection as the source](/images/screenshots/v4/mock-severs/tutorial-create-mock-server.webp)

		Bruno opens the mock [dashboard](/mock-servers/run-mock-server#dashboard-interface-walkthrough). The server is not running yet — you still need to sync examples, then start it.

	\| Any rule OR \| One passing condition is enough. \|
	\| Any rule (OR) \| One passing condition is enough. \|


		![Rules editor with Save, Try, and Try Result](/images/screenshots/v4/mock-severs/tutorial-collection-examples-rules.webp)

		With the mock server running, click Try next to the response URL to send the demo request. Open the Try Result tab on the right: it shows only the body and headers you defined in Expected and Headers. Anything not set there will not appear in Try Result.


		With the mock server running, click Try next to the response URL to send the demo request. Open the Try Result tab on the right: it shows only the body and headers you defined in Expected and Headers. Anything not set there will not appear in Try Result.

		Demo Request is generated from the rules you defined. It shows a sample request that would select this response, so you can copy it into a client or use Try while the server is running.


		### Right section: expected body and headers

		Use this side to define what the mock returns: the Expected body and Headers, plus the status code.

	Use this side to define what the mock returns: the Expected body and Headers, plus the status code.
	Use this side to see what the mock returns: the Expected body and Headers, plus the status code.


		The body can be JSON, HTML, text, or XML. Headers are independent of body type, set `Content-Type` and any other headers the client should see.

		Try Result shows the response body and headers from Expected and Headers after you click Try. Only those values appear — the tab does not invent extra fields.

Uh oh!

Conversation

ganesh-bruno commented Aug 25, 2026

Uh oh!

mintlify Bot commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anthonyd-bruno left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mintlify Bot commented Aug 25, 2026 •

edited

Loading