项目描述
翻译我们的REST API已经增长到超过四十个端点，目前没有一个是文档化的。与我们集成的开发者实际上是在通过示例请求反向工程API，这减慢了每个人的速度，并产生了一连串可避免的支持问题。我们希望通过委托一个完整的OpenAPI 3.0规范以及一个人们可以实际阅读和尝试的精美开发者门户来妥善解决这个问题。
我们正在寻找一个将强大的技术写作与实际的API经验相结合的人，因为这项工作既关乎清晰的解释，也关乎准确的模式。您将制作一个完整的OpenAPI 3.0 YAML规范，涵盖每个端点、其请求和响应模式及其错误代码，然后将其转化为使用Swagger UI或Redoc托管的交互式文档。在参考资料的基础上，我们需要一个入门指南，介绍身份验证、速率限制、分页和错误处理，以及每个主要端点的cURL、PHP和JavaScript代码示例。最后附上一个Postman集合和版本历史的变更日志模板。
我们将提供API访问、现有的内部代码文档和完整的端点列表；我们期望在21天内完成文档。
交付物：
— 1. OpenAPI 3.0 YAML规范 — 所有端点，请求/响应模式，错误代码
— 2. 交互式API文档 — Swagger UI或Redoc托管页面
— 3. 入门指南 — 身份验证、速率限制、分页、错误
— 4. 代码示例 — 每个主要端点的cURL、PHP、JavaScript
— 5. 变更日志 — 版本历史模板
— 6. Postman集合导出
流程：
— 我们提供：API访问、现有代码库文档、端点列表
— 你交付：21天内完成的文档
— 需要强大的技术写作和API经验
我们正在寻找一个将强大的技术写作与实际的API经验相结合的人，因为这项工作既关乎清晰的解释，也关乎准确的模式。您将制作一个完整的OpenAPI 3.0 YAML规范，涵盖每个端点、其请求和响应模式及其错误代码，然后将其转化为使用Swagger UI或Redoc托管的交互式文档。在参考资料的基础上，我们需要一个入门指南，介绍身份验证、速率限制、分页和错误处理，以及每个主要端点的cURL、PHP和JavaScript代码示例。最后附上一个Postman集合和版本历史的变更日志模板。
我们将提供API访问、现有的内部代码文档和完整的端点列表；我们期望在21天内完成文档。
交付物：
— 1. OpenAPI 3.0 YAML规范 — 所有端点，请求/响应模式，错误代码
— 2. 交互式API文档 — Swagger UI或Redoc托管页面
— 3. 入门指南 — 身份验证、速率限制、分页、错误
— 4. 代码示例 — 每个主要端点的cURL、PHP、JavaScript
— 5. 变更日志 — 版本历史模板
— 6. Postman集合导出
流程：
— 我们提供：API访问、现有代码库文档、端点列表
— 你交付：21天内完成的文档
— 需要强大的技术写作和API经验
文本和翻译 现金, 银行转账
