Endpoint Request Snippet

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

1
<EndpointRequestSnippet endpoint="POST /snippets" />

will be rendered as:

1
curl -X POST https://api.buildwithfern.com/snippets \
2
     -H "Authorization: Bearer <token>" \
3
     -H "Content-Type: application/json" \
4
     -d '{
5
  "endpoint": {
6
    "method": "GET",
7
    "path": "/v1/search"
8
  }
9
}'

Reference particular examples

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

1
  <EndpointRequestSnippet 
2
    endpoint="PUT /pet" 
3
    example="ExampleWithMarkley"
4
  />