Endpoint Response Snippet

The EndpointResponseSnippet component is used to reference an endpoint response from your API Reference. Below is an example of referencing the response for the POST /snippets endpoint.

Markdown
1<EndpointResponseSnippet endpoint='POST /snippets' />

will be rendered as

Reference particular examples

If you want to reference a particular example in the response snippet, you can set example prop to the name of the example. See the steps below:

1

Define named examples

The highlighted lines show how to set the example name.

2

Reference the example

In the API Definition, the example had a name ExampleWithMarkley. You can reference the example directly:

1  <EndpointResponseSnippet 
2    endpoint="GET /pet/{petId}" 
3    example="ExampleWithMarkley"
4  />