Claude生成的接口字段说明需严格包含字段名、类型、描述三要素，采用竖线分隔表格或OpenAPI 3.0 schema格式，保留嵌套路径，禁用模糊词与中文类型名，确保可直接发布至开发者门户。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要让claude生成的接口返回示例字段说明，能直接贴进对外技术文档、api平台或开发者门户中发布，而不是仅用于内部调试理解。先确认输出结构是否符合标准文档规范
打开Claude对话界面，输入提示词前，先检查你给它的示例返回体是否包含三类必需元素：字段名、类型、描述。缺任何一类，生成的字段说明都会漏信息，比如只写{"code":0}却不说明code是整型、代表状态码，下游开发者无法安全解析。
把原始JSON响应复制进提示词时，用代码块包裹，并在上方加一句说明：“以下为真实接口返回体，请严格按字段名→类型→描述三级结构输出，不要添加额外解释。”
用结构化指令锁定输出格式
方法一：用分隔符强制字段对齐
在提示词末尾明确写：“请用竖线分隔字段名、类型、说明，每行一个字段，首行是表头：| 字段名 | 类型 | 说明 |”。这样Claude会输出Markdown表格，可直接粘贴进Confluence或Swagger UI的Description区域。
方法二：要求嵌套式JSON Schema风格
输入：“请将以下返回体转换为OpenAPI 3.0兼容的schema片段，每个字段必须含type、description，required数组只列出必填字段。” 这样输出结果能被Postman、Apifox等工具自动识别并渲染成交互式文档。
【注意：如果原始返回里有嵌套对象（如data.user.name），Claude可能扁平化处理。必须在提示词中强调“保留原始嵌套层级，用点号表示路径”】
过滤掉不适合发布的表述
第一步：禁止出现“示例值”“模拟数据”“仅供参考”等弱化语气词——这些词会削弱文档权威性，开发者看到会怀疑字段是否真实存在。
第二步：替换口语化描述。比如把“这个字段就是用户昵称啦”改成“用户在平台设置的显示名称，最大长度32字符，支持中英文及常见符号”。
第三步：统一类型命名。要求Claude使用标准类型词：string / integer / boolean / array / object，不接受“字符串”“数字”“列表”等中文泛称。
这一步操作起来很简单，直接在提示词末尾加一句：“所有描述禁用‘例如’‘比如’‘一般’‘可能’等模糊限定词；类型名必须与OpenAPI 3.0规范完全一致。”
