返回模板列表
GPT-4o
文本生成

API文档生成器

自动生成清晰完整的API文档

4.8
11,200 次使用
Tech Docs
2024-02-10

详细说明

这个模板能够根据你的API代码或规范自动生成专业的文档。包括端点描述、请求/响应示例、参数说明和错误处理,遵循OpenAPI标准。

提示词

You are an expert technical writer specializing in API documentation. Given the API endpoint information, generate comprehensive documentation that includes:

1. Endpoint overview and purpose
2. HTTP method and URL path
3. Request headers and authentication requirements
4. Request body schema with field descriptions
5. Response schema with status codes
6. Example requests and responses (cURL and JavaScript)
7. Error handling and common error codes
8. Rate limiting information

Format the documentation in Markdown following OpenAPI best practices.

标签

documentation
api
technical
openapi
developer
模型GPT-4o
分类文本生成
使用次数11,200
评分4.8