Chat Schema Display

Визуализатор API- или функциональной схемы — метод, путь, параметры запроса и ответа.

POST/api/sessions

Создаёт новую сессию чата и возвращает её идентификатор. Требуется аутентифицированный пользователь.

systemPromptstringобязательный

Начальный системный промпт для агента.

modelstringнеобязательный

Идентификатор модели — по умолчанию claude-opus-4-7.

toolsstring[]необязательный

Необязательный список инструментов для включения.

idstringобязательный

createdAtstringобязательный

Время создания сессии в формате ISO-8601.

import {
  ChatSchemaDisplay,
  ChatSchemaDisplayContent,
  ChatSchemaDisplayDescription,
  ChatSchemaDisplayHeader,
  ChatSchemaDisplayMethod,
  ChatSchemaDisplayPath,
  ChatSchemaParameter,
  ChatSchemaSection,
} from "@/components/ui/chat-schema-display";

export default function Particle() {
  return (
    <div className="w-full max-w-2xl p-4">
      <ChatSchemaDisplay>
        <ChatSchemaDisplayHeader>
          <ChatSchemaDisplayMethod method="POST" />
          <ChatSchemaDisplayPath>/api/sessions</ChatSchemaDisplayPath>
        </ChatSchemaDisplayHeader>
        <ChatSchemaDisplayDescription>
          Создаёт новую сессию чата и возвращает её идентификатор. Требуется
          аутентифицированный пользователь.
        </ChatSchemaDisplayDescription>

        <ChatSchemaDisplayContent>
          <ChatSchemaSection label="Тело запроса">
            <ChatSchemaParameter
              description="Начальный системный промпт для агента."
              name="systemPrompt"
              required
              type="string"
            />
            <ChatSchemaParameter
              description="Идентификатор модели — по умолчанию claude-opus-4-7."
              name="model"
              type="string"
            />
            <ChatSchemaParameter
              description="Необязательный список инструментов для включения."
              name="tools"
              type="string[]"
            />
          </ChatSchemaSection>

          <ChatSchemaSection label="Ответ">
            <ChatSchemaParameter name="id" required type="string" />
            <ChatSchemaParameter
              description="Время создания сессии в формате ISO-8601."
              name="createdAt"
              required
              type="string"
            />
          </ChatSchemaSection>
        </ChatSchemaDisplayContent>
      </ChatSchemaDisplay>
    </div>
  );
}

Установка


pnpm dlx shadcn@latest add @oracul/chat-schema-display

Использование

import {
  ChatSchemaDisplay,
  ChatSchemaDisplayContent,
  ChatSchemaDisplayDescription,
  ChatSchemaDisplayHeader,
  ChatSchemaDisplayMethod,
  ChatSchemaDisplayPath,
  ChatSchemaParameter,
  ChatSchemaSection,
} from "@/components/ui/chat-schema-display";
 
<ChatSchemaDisplay>
  <ChatSchemaDisplayHeader>
    <ChatSchemaDisplayMethod method="POST" />
    <ChatSchemaDisplayPath>/api/sessions</ChatSchemaDisplayPath>
  </ChatSchemaDisplayHeader>
  <ChatSchemaDisplayDescription>
    Create a new chat session and return its ID.
  </ChatSchemaDisplayDescription>
 
  <ChatSchemaDisplayContent>
    <ChatSchemaSection label="Request body">
      <ChatSchemaParameter
        description="Initial system prompt for the agent."
        name="systemPrompt"
        required
        type="string"
      />
      <ChatSchemaParameter
        description="Model identifier (claude-opus-4-7 by default)."
        name="model"
        type="string"
      />
    </ChatSchemaSection>
 
    <ChatSchemaSection label="Response">
      <ChatSchemaParameter name="id" required type="string" />
      <ChatSchemaParameter name="createdAt" required type="string (ISO)" />
    </ChatSchemaSection>
  </ChatSchemaDisplayContent>
</ChatSchemaDisplay>

Методы

GET / POST / PUT / PATCH / DELETE / HEAD / OPTIONS — у каждого свой цвет бейджа.

<ChatSchemaParameter> рендерит имя (моноширинным), тип (моноширинным приглушённым) и признак «обязательный/необязательный». description выводится серой строкой ниже.

На этой странице

Установка Использование Методы