爬虫采集API集成说明清晰框架提示词

角色定义

请以技术文档架构师的身份使用这组提示词。你的核心目标是为爬虫数据采集系统的API集成说明设计一套清晰、可复用、结构分层的框架方案。你需要将抽象的接口文档需求转化为具体的模块划分、参数描述、错误码表格以及示例代码，确保开发人员或集成方能够直接参照此框架快速完成对接，同时避免遗漏关键通信细节（如鉴权、频率限制、响应格式）。

适用场景

• 编写面向第三方开发者的爬虫API接口文档（如公开数据采集服务、代理IP池接口等）。
• 设计内部数据抓取系统的集成说明，供前后端或数据工程师参考。
• 生成用于演示或培训的“API集成最佳实践”视觉素材（如流程图、表格框架）。
• 为爬虫平台（如Scrapy、Requests）撰写标准化的接口接入指南。

核心提示词

以下提示词可直接复制用于AI生成或文档起草：

• 基础框架提示词：“请以技术文档风格生成一份爬虫数据采集API集成说明，结构需包含：1. 接口概述（用途、基础URL、协议）；2. 鉴权方式（API密钥或OAuth2.0）；3. 请求参数表格（参数名、类型、必填、描述、默认值）；4. 响应格式（JSON对象字段说明，包括data、status、message）；5. 错误码枚举（code与含义对照表）；6. 频率限制说明（每分钟/每小时最大请求数及返回头字段）；7. 代码示例（Python/curl各一个完整调用示例，含错误处理）。”
• 细化模块提示词：“为上述框架中的请求参数部分生成表格：包含参数名keyword（string，必填，搜索关键词）、page（integer，选填，页码，默认1）、page_size（integer，选填，每页条数，最大100）、sort（string，选填，排序方式，可选'date'/'relevance'）。”

风格方向

• 专业简洁：避免冗余修饰，直接使用技术术语（如端点、负载、状态码）。
• 层次清晰：通过数字编号或模块标题区分各板块，每板块配简短说明。
• 示例驱动：每个关键流程（鉴权、请求、解析响应）均配有可运行的代码片段。
• 视觉友好：如果用于图像生成，建议采用浅灰/蓝色调背景，左侧为表格和文本，右侧为流程箭头或请求-响应示意图。

构图建议

• 文档页式：整体采用A4纸张比例的竖版构图，顶部为标题“爬虫采集API集成说明”，下方依次排列各模块框，模块间用细分割线隔开。
• 表格优先：参数与错误码部分使用两列或三列表格，表头加粗且底色深灰，行交替浅色背景。
• 流程图辅助：在“频率限制”或“鉴权流程”旁插入一个简化流程图：客户端→API网关→鉴权模块→数据返回，节点用圆角矩形，箭头为深蓝。
• 代码块设计：代码示例区域使用等宽字体（如Consolas），背景为深色（接近#282c34），文字为亮绿色或白色，行号可选。

细节强化

• 端点命名：所有API端点建议统一为/v1/crawl/{resource} 格式，并在参数部分单独强调路径变量。
• 响应字段：说明中应明确每个响应字段的数据类型、可能的null值及示例值（如"total_count": 1234）。
• 错误处理：在代码示例中展示如何解析error_code并输出友好提示，例如 if response.status_code == 429: time.sleep(retry_after)。
• 聚合说明：在频率限制部分，增加对HTTP响应头X-RateLimit-Remaining和X-RateLimit-Reset的解读。

使用建议

• 直接粘贴使用：将“核心提示词”中的框架提示词直接输入到AI绘图工具（如Midjourney、DALL·E）的文字区域，可配合风格方向里的色彩描述生成示意图；若用于文本生成（如ChatGPT），则根据上述模块逐段生成文档。
• 分拆模块：对大型文档，建议将每个模块（如鉴权、参数表格）单独提取为一个提示词任务，避免生成内容过长导致细节遗漏。
• 自定义扩展：若目标爬虫系统使用WebSocket或gRPC，可将“请求方法”从HTTP替换为对应协议，并增加连接建立/关闭的说明。
• 版本标注：在框架顶部添加一行版本号（如“v2.3.1”）和最近更新日期，保持文档的权威感。