端点请求片段

使用 <EndpointRequestSnippet> 组件来引用 API Reference 中的端点请求。

使用方法

POST

/chat/:domain

1 curl -X POST https://fai.buildwithfern.com/chat/domain \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "messages": [
6     {
7       "role": "user",
8       "content": "string"
9     }
10   ]
11 }'

试一试

Markdown

1 <EndpointRequestSnippet endpoint="POST /chat/{domain}" />

引用特定示例

在规范中设置示例名称

openapi.yml

1 paths:
2   /pet:
3     put:
4       summary: Update an existing pet 
5       operationId: pets_update
6       requestBody: 
7         content:
8           application/json:
9             schema:
10               $ref: '#/components/schemas/Pet'
11             examples:
12               ExampleWithMarkley:
13                 value: 
14                   name: Markley
15                   id: 44

直接引用示例

Markdown

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

引用示例

如果示例包含 summary 或 docs 字段，请将其用作 example 属性的值。如果没有设置 summary，则使用示例名称。

变体

过滤语言

使用 languages 属性来过滤下拉菜单中显示的语言并控制其顺序。

POST

/chat/:domain

1 curl -X POST https://fai.buildwithfern.com/chat/domain \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "messages": [
6     {
7       "role": "user",
8       "content": "string"
9     }
10   ]
11 }'

试一试

Markdown

1 <EndpointRequestSnippet 
2   endpoint="POST /chat/{domain}" 
3   languages={["curl", "python", "typescript"]}
4 />

显示有效载荷

payload 选项为 POST/PUT/PATCH 请求显示原始 JSON 请求体，或为 GET 请求显示查询参数。

POST

/chat/:domain

1 curl -X POST https://fai.buildwithfern.com/chat/domain \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "messages": [
6     {
7       "role": "user",
8       "content": "string"
9     }
10   ]
11 }'

试一试

Markdown

1 <EndpointRequestSnippet 
2   endpoint="POST /chat/{domain}" 
3   languages={["curl", "python", "payload"]}
4 />

隐藏试用按钮

EndpointRequestSnippet 组件默认包含一个试用按钮。使用 hideTryItButton 属性来隐藏它。

POST

/chat/:domain

1 curl -X POST https://fai.buildwithfern.com/chat/domain \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "messages": [
6     {
7       "role": "user",
8       "content": "string"
9     }
10   ]
11 }'

Markdown

1 <EndpointRequestSnippet 
2   endpoint="POST /chat/{domain}" 
3   hideTryItButton={true}
4 />

属性

endpoint

stringRequired

要显示的端点，格式为 METHOD /path（例如：POST /chat/{domain}）。如果您的 API 使用命名空间，请在前面加上命名空间和 ::（例如：payments::POST /chat/{domain}）。

example

string

要显示的特定示例的名称。如果示例包含 summary 或 docs 字段，请使用该值。

highlight

number | number[]

代码片段中要高亮的行号。接受单个数字、数字数组或范围（例如：{[1-3, 5]}）。

languages

string[]

指定下拉菜单中显示哪些语言以及显示顺序。支持的值包括 curl、python、typescript、javascript、go、ruby、java、kotlin、csharp、php、swift、rust 和 payload。未指定时，显示所有可用语言。

hideTryItButton

boolean

当设置为 true 时，从片段中隐藏试用按钮。

1	curl -X POST https://fai.buildwithfern.com/chat/domain \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"messages": [
6	{
7	"role": "user",
8	"content": "string"
9	}
10	]
11	}'

1	paths:
2	/pet:
3	put:
4	summary: Update an existing pet
5	operationId: pets_update
6	requestBody:
7	content:
8	application/json:
9	schema:
10	$ref: '#/components/schemas/Pet'
11	examples:
12	ExampleWithMarkley:
13	value:
14	name: Markley
15	id: 44

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

1	<EndpointRequestSnippet
2	endpoint="POST /chat/{domain}"
3	languages={["curl", "python", "typescript"]}
4	/>

1	<EndpointRequestSnippet
2	endpoint="POST /chat/{domain}"
3	languages={["curl", "python", "payload"]}
4	/>

1	<EndpointRequestSnippet
2	endpoint="POST /chat/{domain}"
3	hideTryItButton={true}
4	/>