TokenToSea提示词广场
English 控制台

API 文档生成

编程开发·任务模板

在聊天中使用

根据 API 基本信息和接口详情生成 API 文档,包括认证、参数、请求响应示例和错误码。

填写变量

填写后,下方提示词与复制内容会同步替换。

中文原文
你的任务是生成清晰完整的API文档。请基于以下信息编写文档:

<API信息>
API名称:{{api_name}}
服务功能:{{service_function}}
版本信息:{{version_info}}
认证方式:{{authentication}}
基础URL:{{base_url}}
</API信息>

<接口详情>
{{api_endpoints}}
</接口详情>

请生成包含以下内容的API文档:
1. API概述和使用说明
2. 认证和授权机制
3. 详细的接口列表和参数
4. 请求响应示例
5. 错误码和异常处理

请在<api-docs>标签内输出完整的API文档。