API文档撰写
Text Prompt
该提示要求模型撰写特定编程语言(如Python或JavaScript)关于某一主题(如REST API设计)的API文档。适用于开发者编写技术文档的场景,输出需包含简介、接口列表、参数说明、返回示例和错误码定义等结构化内容。特别强调针对目标语言的特性(如装饰器、异步处理)提供适配说明,并建议使用代码片段和交互式示例提升可读性,同时附上版本
正文长度
预估 Token
语言
最后核验
Token 为按中文字符与英文长度估算的近似值,方便判断这条 Prompt 更适合直接复制,还是先裁切后再使用。
Prompt 操作
这条 Prompt 为付费内容,解锁后可查看并复制完整正文,单条永久有效。
作者
未标注
分类
开发编程
输入位
未提供
负向提示词
未提供
Prompt 正文
下面是正文开头片段,解锁后展示完整内容并可一键复制。
如何撰写关于{language}的{topic}主题的API文档?请从整体结构出发,包括简介、接口列表、参数说明、返回示例和错误码定义。…还有约 94 字正文未显示
- · 解锁后可查看并复制完整正文
- · 单条永久有效,解锁后随时回来查看
虚拟内容,解锁后不支持退款
去使用这个 Prompt
使用建议
分类
这条 Prompt 属于什么类型
开发编程
说明
这条 Prompt 怎么理解
该提示要求模型撰写特定编程语言(如Python或JavaScript)关于某一主题(如REST API设计)的API文档。适用于开发者编写技术文档的场景,输出需包含简介、接口列表、参数说明、返回示例和错误码定义等结构化内容。特别强调针对目标语言的特性(如装饰器、异步处理)提供适配说明,并建议使用代码片段和交互式示例提升可读性,同时附上版本
难度
新手可用
如果你经常需要自己补上下文、改结构、加约束,可以优先用这类更完整的长 Prompt。
商用
reference_only
是否适合商用、公开分发或二次整理,建议结合来源声明和具体使用场景再确认。
继续浏览同类 Prompt
上一个 Prompt
Apifox全栈精通
此提示词指导模型全面讲解Apifox API开发工具的核心功能,包括接口设计、测试脚本编写与团队协作。适用于技术开发、API管理培训等场景,输出需分模块提供实操步骤与最佳实践,强调技术准确性与实用性,适合开发者技能提升或企业工具推广。适合开发编程相关任务中直接调用。使用时可结合具体对象、语气和输出格式继续补充条件。
下一个 Prompt
ASCII编码艺术家
将物体描述转换为ASCII艺术图形,仅输出代码形式。适用于编程练习或趣味创作,需输出精确字符画,不附加解释。适合开发编程相关任务中直接调用。使用时可结合具体对象、语气和输出格式继续补充条件。这样更容易得到结构清晰、方向贴合且可直接落地的回复。若用于实际业务,可先补充主题背景、目标受众和结果格式,再复制使用。