FastGPT/packages/global/openapi/index.ts

import { createDocument } from 'zod-openapi';
import { ChatPath } from './core/chat';
import { TagsMap } from './tag';
import { PluginPath } from './core/plugin';
import { AppPath } from './core/app';
import { SupportPath } from './support';
import { DatasetPath } from './core/dataset';

export const openAPIDocument = createDocument({
  openapi: '3.1.0',
  info: {
    title: 'FastGPT API',
    version: '0.1.0',
    description: 'FastGPT API 文档'
  },
  paths: {
    ...AppPath,
    ...ChatPath,
    ...DatasetPath,
    ...PluginPath,
    ...SupportPath
  },
  servers: [{ url: '/api' }],
  'x-tagGroups': [
    {
      name: 'Agent 应用',
      tags: [TagsMap.appCommon, TagsMap.appLog, TagsMap.publishChannel]
    },
    {
      name: '对话管理',
      tags: [
        TagsMap.chatPage,
        TagsMap.chatHistory,
        TagsMap.chatController,
        TagsMap.chatFeedback,
        TagsMap.chatSetting
      ]
    },
    {
      name: '知识库',
      tags: [TagsMap.datasetCollection]
    },
    {
      name: '插件系统',
      tags: [TagsMap.pluginToolTag, TagsMap.pluginTeam]
    },
    {
      name: '用户体系',
      tags: [TagsMap.userInform, TagsMap.walletBill, TagsMap.walletDiscountCoupon]
    },
    {
      name: '通用-辅助功能',
      tags: [TagsMap.customDomain, TagsMap.apiKey]
    },
    {
      name: '管理员-插件管理',
      tags: [TagsMap.pluginAdmin, TagsMap.pluginMarketplace, TagsMap.pluginToolAdmin]
    }
  ]
});