项目描述
翻译我们的 REST API 已增长到超过四十个端点，但今天没有一个是文档化的。与我们集成的开发者基本上是从请求示例中反向工程 API 逻辑——这会减慢进度并产生大量支持问题。我们希望彻底解决这个问题，并委托一个完整的 OpenAPI 3.0 规范，以及一个精致的开发者门户，在那里文档可以被阅读和实时测试。
我们需要一个结合强大技术写作和真实 API 经验的执行者，因为这个任务同样涉及清晰的解释和精确的模式。我们需要为所有端点准备一个完整的 YAML OpenAPI 3.0 规范——包括请求和响应模式以及错误代码——然后将其转化为 Swagger UI 或 Redoc 中的交互式文档。在参考资料的基础上，我们需要一个入门指南，涵盖身份验证、速率限制、分页和错误处理，以及每个关键端点的 cURL、PHP 和 JavaScript 的现成代码示例。一个 Postman 集合和变更日志模板完成整个图景。
我们提供 API 访问、内部代码文档和完整的端点列表；我们期望在 21 天内完成文档。
结果：
— 1. OpenAPI 3.0 YAML 规范 — 所有端点，请求/响应模式，错误代码
— 2. 交互式文档 (Swagger UI 或 Redoc)
— 3. 入门指南 — 身份验证、限制、分页、错误
— 4. 代码示例 — 每个关键端点的 cURL、PHP、JS
— 5. 变更日志模板
— 6. Postman 集合
过程：
— 我们提供：API 访问、代码文档、端点列表
— 你：在 21 天内完成文档
我们需要一个结合强大技术写作和真实 API 经验的执行者，因为这个任务同样涉及清晰的解释和精确的模式。我们需要为所有端点准备一个完整的 YAML OpenAPI 3.0 规范——包括请求和响应模式以及错误代码——然后将其转化为 Swagger UI 或 Redoc 中的交互式文档。在参考资料的基础上，我们需要一个入门指南，涵盖身份验证、速率限制、分页和错误处理，以及每个关键端点的 cURL、PHP 和 JavaScript 的现成代码示例。一个 Postman 集合和变更日志模板完成整个图景。
我们提供 API 访问、内部代码文档和完整的端点列表；我们期望在 21 天内完成文档。
结果：
— 1. OpenAPI 3.0 YAML 规范 — 所有端点，请求/响应模式，错误代码
— 2. 交互式文档 (Swagger UI 或 Redoc)
— 3. 入门指南 — 身份验证、限制、分页、错误
— 4. 代码示例 — 每个关键端点的 cURL、PHP、JS
— 5. 变更日志模板
— 6. Postman 集合
过程：
— 我们提供：API 访问、代码文档、端点列表
— 你：在 21 天内完成文档
文本和翻译 现金, 银行转账
