Search for a command to run...
探索我们完整的 OpenAPI 组件库，包含 85+ 个高质量组件，专为现代 API 文档而设计。
用于构建 API 文档的基础 UI 组件
用于显示和管理 API 参数的组件
用于显示数据结构和模式的组件
用于显示 API 响应和状态的组件
用于显示 API 安全配置的组件
为不同编程语言生成 API 调用代码
提供交互功能的高级组件
用于构建完整 API 文档页面的布局组件
/api/users获取用户列表/api/users创建新用户/api/users/{id}更新用户信息/api/users/{id}删除用户/api/users/{id}部分更新用户用于筛选和分页的查询参数
URL 路径中的必需参数
HTTP 请求头中的参数
Cookie 中传递的参数
完整的用户数据结构，包含个人信息、偏好设置等
用户信息对象，包含用户的基本信息和偏好设置
用户唯一标识符
用户邮箱地址
用户姓名
用户头像 URL
用户年龄
用户账户状态
pendingactiveinactivependingsuspended用户角色列表
用户详细资料
名
姓
手机号码
地址信息
用户偏好设置
界面主题
autolightdarkauto界面语言
en-USzh-CNen-USja-JPfr-FR通知设置
truefalsefalse用户时区
账户创建时间
最后更新时间
最后登录时间
标准化的 API 响应格式，包含数据、错误信息和分页
标准 API 响应格式
请求是否成功
响应数据
响应消息
错误信息列表
错误字段
错误代码
错误描述
分页信息
电商产品数据结构，包含价格、库存、规格等信息
电商产品信息模型
产品 ID
产品名称
产品描述
产品价格（美元）
价格货币
USDUSDEURCNYJPY产品分类
产品标签
是否有库存
库存数量
产品图片 URL 列表
产品规格
完整的用户数据模型，包含基本信息、资料和嵌套对象结构
{
"id": "user_123e4567-e89b-12d3-a456-426614174000",
"email": "john.doe@example.com",
"name": "John Doe",
"avatar": "https://cdn.example.com/avatars/john-doe.jpg",
"role": "admin",
"profile": {
"bio": "资深软件工程师，专注于 API 设计和微服务架构",
"phone": "+86 138-0013-8000",
"address": {
"country": "中国",
"city": "北京",
"street": "中关村大街1号"
}
},
"createdAt": "2024-01-15T10:30:00Z"
}电商产品的完整数据结构，包含价格、规格、库存等信息
{
"id": "prod_987fcdeb-51a2-4567-8901-234567890abc",
"name": "iPhone 15 Pro",
"description": "Apple 最新旗舰智能手机，配备 A17 Pro 芯片和钛金属机身",
"price": 7999,
"currency": "CNY",
"category": "electronics",
"images": [
"https://cdn.example.com/products/iphone15pro-front.jpg",
"https://cdn.example.com/products/iphone15pro-back.jpg"
],
"specifications": {
"display": "6.1英寸 Super Retina XDR",
"storage": "256GB",
"color": "天然钛金属色",
"weight": "187g"
},
"inStock": true,
"stockQuantity": 150,
"tags": [
"smartphone",
"premium",
"5g",
"titanium"
]
}标准的 API 响应格式，包含数据、分页信息和元数据
{
"success": true,
"data": {
"users": [
{
"id": "user_001",
"name": "Alice Johnson",
"email": "alice@example.com"
},
{
"id": "user_002",
"name": "Bob Smith",
"email": "bob@example.com"
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 156,
"totalPages": 8
}
},
"message": "用户列表获取成功",
"timestamp": "2024-03-15T14:30:00Z",
"requestId": "req_789abc12-def3-4567-8901-234567890def"
}API 错误响应的标准格式，包含错误代码和详细信息
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "请求参数验证失败",
"details": [
{
"field": "email",
"message": "邮箱格式不正确"
},
{
"field": "password",
"message": "密码长度至少8位"
}
]
},
"timestamp": "2024-03-15T14:35:00Z",
"requestId": "req_error123-456-789-abc-def012345678"
}支付交易的完整数据结构，包含支付方式和卡片信息
{
"id": "pay_abc123def456-789-012-345-678901234567",
"orderId": "order_456e7890-a12b-34c5-6789-012345678901",
"amount": 10887.8,
"currency": "CNY",
"method": "credit_card",
"status": "completed",
"gateway": "stripe",
"transactionId": "txn_stripe_ch_1234567890abcdef",
"cardInfo": {
"last4": "4242",
"brand": "visa",
"expiryMonth": 12,
"expiryYear": 2027
},
"createdAt": "2024-03-15T09:20:15Z",
"completedAt": "2024-03-15T09:20:18Z"
}数组类型的数据结构，展示分类列表的层级关系
[
{
"id": "cat_electronics",
"name": "电子产品",
"description": "各类电子设备和数码产品",
"parentId": null,
"level": 1
},
{
"id": "cat_smartphones",
"name": "智能手机",
"description": "各品牌智能手机",
"parentId": "cat_electronics",
"level": 2
},
{
"id": "cat_laptops",
"name": "笔记本电脑",
"description": "便携式电脑设备",
"parentId": "cat_electronics",
"level": 2
}
]Successful response
Number of requests allowed per hour
Unique identifier for the request
Get user details using the returned user ID
Error response
Simple response without additional details
包含成功响应和各种错误情况的完整响应定义
文件上传接口的响应，包含文件信息和错误处理
带分页信息的列表数据响应格式
最常用的 API 认证方式，将密钥放在请求头中传递
API 密钥认证，将密钥放在请求头中。请在开发者控制台获取您的 API 密钥。
将 API 密钥作为查询参数传递，适用于无法设置请求头的场景
API 密钥认证，将密钥作为查询参数传递。适用于无法设置请求头的场景。
JWT Bearer Token 认证，现代 API 的标准认证方式
JWT Bearer Token 认证。在 Authorization 头中使用 'Bearer <token>' 格式。
传统的 HTTP 基本认证，使用用户名和密码进行身份验证
HTTP 基本认证，使用用户名和密码进行身份验证。凭据会被 Base64 编码。
标准的 OAuth 2.0 授权框架，支持多种授权流程
OAuth 2.0 授权框架，支持多种授权流程。适用于第三方应用集成。
https://auth.example.com/oauth/authorizeToken URL: https://auth.example.com/oauth/tokenRefresh URL: https://auth.example.com/oauth/refreshScopes:read: 读取用户数据write: 修改用户数据admin: 管理员权限https://auth.example.com/oauth/tokenScopes:api:read: 读取 API 数据api:write: 写入 API 数据基于 OAuth 2.0 的身份认证层，支持单点登录功能
OpenID Connect 身份认证，基于 OAuth 2.0 构建的身份层。支持单点登录（SSO）。
基于 Cookie 的会话认证，适用于 Web 应用程序
基于 Cookie 的会话认证。适用于 Web 应用程序的用户会话管理。
自定义的认证头方案，用于特殊的认证需求
自定义认证头，用于特殊的认证需求。请联系技术支持获取认证令牌。
高安全级别的多重认证，结合多种认证方式
多重认证方案，需要同时提供 JWT Token 和 API 密钥。用于高安全级别的操作。
企业级 OAuth 认证，支持 SAML、LDAP 集成
企业级 OAuth 2.0 认证，支持 SAML、LDAP 集成和单点登录。
https://enterprise.example.com/oauth/authorizeToken URL: https://enterprise.example.com/oauth/tokenScopes:enterprise:read: 读取企业数据enterprise:write: 修改企业数据audit:access: 访问审计日志admin:full: 完整管理员权限移动应用专用认证，支持 PKCE 扩展增强安全性
移动应用专用的 OAuth 2.0 认证，支持 PKCE 扩展以增强安全性。
https://mobile.example.com/oauth/authorizeToken URL: https://mobile.example.com/oauth/tokenScopes:mobile:sync: 数据同步push:send: 发送推送通知location:access: 访问位置信息用于验证第三方系统 Webhook 回调请求的真实性
Webhook 签名验证，用于验证第三方系统发送的回调请求的真实性。
最简单的 API 访问认证方式，适用于基础的 API 调用
标准的 OAuth 2.0 授权，支持读取和写入操作权限
用户管理系统的完整权限配置，包含增删改查操作
支付系统的双重认证要求，结合 OAuth 和 API 密钥
系统管理员的高级权限配置，包含系统管理功能
文件管理系统的认证要求，支持 Bearer Token 和 OAuth
数据分析和报表系统的权限配置，支持数据导出功能
第三方系统集成的认证配置，包含 Webhook 认证
传统的 HTTP Basic Authentication，适用于简单的认证场景
基于 Cookie 的会话认证，适用于 Web 应用程序
高安全级别的多重认证配置，结合多种认证方式
企业级安全认证配置，包含证书认证和审计日志
curl -X post "https://api.example.com/users"
-H "Content-Type: application/json"?page=value用户登录接口的 Python requests 代码生成
# Using requests library
import requests
def call_post():
url = "https://api.example.com/v1/auth/login"
headers = {
"Content-Type": "application/json"
}
response = requests.post(url, headers=headers)
return response.json()包含多个查询参数的数据分析接口 Python 代码
# Using requests library
import requests
def call_get():
url = "https://api.example.com/v1/analytics/reports"
headers = {
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
return response.json()ML 模型预测接口的 Python 代码，包含复杂的特征数据
# Using requests library
import requests
def call_post():
url = "https://api.example.com/v1/ml/predict"
headers = {
"Content-Type": "application/json"
}
response = requests.post(url, headers=headers)
return response.json()大数据批量处理接口的 Python 代码生成
# Using requests library
import requests
def call_post():
url = "https://api.example.com/v1/data/batch-process"
headers = {
"Content-Type": "application/json"
}
response = requests.post(url, headers=headers)
return response.json()图像处理和变换接口的 Python 代码生成
# Using requests library
import requests
def call_post():
url = "https://api.example.com/v1/images/process"
headers = {
"Content-Type": "application/json"
}
response = requests.post(url, headers=headers)
return response.json()电商平台产品创建接口的 PHP cURL 代码生成
<?php
// 使用 PHP 的 cURL 扩展
function call_post() {
$url = "https://api.shop.example.com/v1/products";
$curl = curl_init();
$headers = [
"Content-Type: application/json",
"Accept: application/json"
];
curl_setopt_array($curl, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_CUSTOMREQUEST => "post",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
return "cURL Error: " . $err;
} else {
return json_decode($response, true);
}
}包含多个筛选条件的订单查询接口 PHP 代码
<?php
// 使用 PHP 的 cURL 扩展
function call_get() {
$url = "https://api.shop.example.com/v1/orders";
$curl = curl_init();
$headers = [
"Content-Type: application/json",
"Accept: application/json"
];
curl_setopt_array($curl, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_CUSTOMREQUEST => "get",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
return "cURL Error: " . $err;
} else {
return json_decode($response, true);
}
}信用卡支付处理接口的 PHP 代码，包含幂等性处理
<?php
// 使用 PHP 的 cURL 扩展
function call_post() {
$url = "https://api.payment.example.com/v1/charges";
$curl = curl_init();
$headers = [
"Content-Type: application/json",
"Accept: application/json"
];
curl_setopt_array($curl, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_CUSTOMREQUEST => "post",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
return "cURL Error: " . $err;
} else {
return json_decode($response, true);
}
}CMS 文章更新接口的 PHP 代码，包含 SEO 和作者信息
<?php
// 使用 PHP 的 cURL 扩展
function call_put() {
$url = "https://api.cms.example.com/v1/articles";
$curl = curl_init();
$headers = [
"Content-Type: application/json",
"Accept: application/json"
];
curl_setopt_array($curl, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_CUSTOMREQUEST => "put",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
return "cURL Error: " . $err;
} else {
return json_decode($response, true);
}
}邮件发送服务接口的 PHP 代码，支持附件和追踪
<?php
// 使用 PHP 的 cURL 扩展
function call_post() {
$url = "https://api.mail.example.com/v1/send";
$curl = curl_init();
$headers = [
"Content-Type: application/json",
"Accept: application/json"
];
curl_setopt_array($curl, [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => $headers,
CURLOPT_CUSTOMREQUEST => "post",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
return "cURL Error: " . $err;
} else {
return json_decode($response, true);
}
}这个组件演示了如何为 Laravel 应用生成正确的 PHP 代码。
<?php
// 使用 Laravel HTTP 客户端
use Illuminate\Support\Facades\Http;
function call_post()
{
$response = Http::withHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
]).post("https://api.laravel-app.com/api/v1/users");
return $response->json();
}
// 或者使用 Laravel 的 Guzzle 封装
public function call_post_guzzle()
{
$client = new \GuzzleHttp\Client();
$response = $client->request("post", "https://api.laravel-app.com/api/v1/users", [
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]);
return json_decode($response->getBody(), true);
}<?php
// 使用 Laravel HTTP 客户端
use Illuminate\Support\Facades\Http;
function call_get()
{
$response = Http::withHeaders([
'Content-Type' => 'application/json',
'Accept' => 'application/json',
]).get("https://api.laravel-app.com/api/v1/users/{id}");
return $response->json();
}
// 或者使用 Laravel 的 Guzzle 封装
public function call_get_guzzle()
{
$client = new \GuzzleHttp\Client();
$response = $client->request("get", "https://api.laravel-app.com/api/v1/users/{id}", [
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]);
return json_decode($response->getBody(), true);
}测试创建用户的 API 接口
测试获取用户信息的 API 接口