API 端点
2 分
API 端点 块会呈现交互式 API 文档，包括请求参数、代码示例和响应示例。
语法
您可以使用 Markdown 或 MDX 语法添加此组件。
<ApiMethodV2>
(JSON configuration with name, method, url, request, examples, results)
</ApiMethodV2>JSON 配置支持以下参数组：
- pathParameters
- 查询参数
- 标头参数
- bodyDataParameters
- formDataParameters
您还可以包含多语言的请求示例和响应示例。
在双栏布局中使用时，API 端点块会呈现在右侧列。
MDX 示例
以下示例创建了一个用于检索用户的端点，包括请求参数、多段代码示例和响应示例。
<ApiMethodV2>
{
"name": "Get User",
"method": "GET",
"url": "https://api.example.com/users/{id}",
"description": "Retrieve a user by their unique ID.",
"tab": "examples",
"examples": {
"languages": [
{
"id": "js-example",
"language": "javascript",
"code": "const res = await fetch('https://api.example.com/users/usr_abc123', {\n headers: { 'Authorization': 'Bearer sk_live_xxx' }\n})\nconst user = await res.json()",
"customLabel": ""
},
{
"id": "curl-example",
"language": "bash",
"code": "curl https://api.example.com/users/usr_abc123 \\\n -H 'Authorization: Bearer sk_live_xxx'",
"customLabel": ""
}
],
"selectedLanguageId": "js-example"
},
"results": {
"languages": [
{
"id": "res-200",
"language": "200",
"code": "{\n \"id\": \"usr_abc123\",\n \"name\": \"Jane Doe\",\n \"email\": \"[email protected]\",\n \"role\": \"admin\"\n}",
"customLabel": ""
},
{
"id": "res-404",
"language": "404",
"code": "{\n \"error\": \"Not found\",\n \"message\": \"User does not exist\"\n}",
"customLabel": ""
}
],
"selectedLanguageId": "res-200"
},
"request": {
"pathParameters": [
{
"name": "id",
"kind": "required",
"type": "string",
"description": "User ID (e.g. usr_abc123)"
}
],
"queryParameters": [
{
"name": "include",
"kind": "optional",
"type": "string",
"description": "Comma-separated relations to include"
}
],
"headerParameters": [
{
"name": "Authorization",
"kind": "required",
"type": "string",
"description": "Bearer token"
}
],
"bodyDataParameters": [],
"formDataParameters": []
},
"currentNewParameter": {
"label": "Path Parameter",
"value": "pathParameters"
},
"hasTryItOut": false
}
</ApiMethodV2>Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.