Response Item

import { ResponseItem } from "@/components/pivot/response-item";

<ResponseItem
  statusCode={200}
  description="成功返回用户信息"
  schema={userSchema}
/>

const userSchema = {
  type: "object",
  properties: {
    id: { type: "string", format: "uuid" },
    name: { type: "string" },
    email: { type: "string", format: "email" },
    created_at: { type: "string", format: "date-time" },
  },
};
 
<ResponseItem
  statusCode={200}
  description="成功返回用户信息"
  schema={userSchema}
  example={{
    id: "123e4567-e89b-12d3-a456-426614174000",
    name: "张三",
    email: "zhangsan@example.com",
    created_at: "2023-12-01T10:00:00Z",
  }}
/>;

const errorSchema = {
  type: "object",
  properties: {
    error: {
      type: "object",
      properties: {
        code: { type: "string" },
        message: { type: "string" },
        details: { type: "array", items: { type: "string" } },
      },
    },
  },
};
 
<div className="space-y-4">
  <ResponseItem
    statusCode={400}
    description="请求参数错误"
    schema={errorSchema}
    example={{
      error: {
        code: "INVALID_REQUEST",
        message: "请求参数不正确",
        details: ["email 字段格式不正确"],
      },
    }}
  />
 
  <ResponseItem
    statusCode={404}
    description="用户不存在"
    schema={errorSchema}
    example={{
      error: {
        code: "USER_NOT_FOUND",
        message: "指定的用户不存在",
      },
    }}
  />
 
  <ResponseItem
    statusCode={500}
    description="服务器内部错误"
    schema={errorSchema}
  />
</div>;

const paginatedUsersSchema = {
  type: "object",
  properties: {
    data: {
      type: "array",
      items: {
        type: "object",
        properties: {
          id: { type: "string" },
          name: { type: "string" },
          email: { type: "string" },
        },
      },
    },
    pagination: {
      type: "object",
      properties: {
        page: { type: "integer" },
        limit: { type: "integer" },
        total: { type: "integer" },
        pages: { type: "integer" },
      },
    },
  },
};
 
<ResponseItem
  statusCode={200}
  description="成功返回用户列表"
  schema={paginatedUsersSchema}
  headers={{
    "X-Total-Count": "150",
    "X-Page-Count": "8",
  }}
/>;