项目描述
翻译我们公司构建了一个REST API,合作开发者可以用它与我们的平台集成,但当前的文档已经过时,并且分散在内部维基和旧电子表格中。我们正在寻找一位经验丰富的技术写作人员,能够将我们现有的端点转化为一个清晰、结构化的参考,开发者可以依赖它,而无需每次遇到问题时都给我们的支持团队发邮件。
这项工作涵盖所有公共端点:清晰描述每个方法的功能,所需和可选参数的完整细分,包括类型和默认值,身份验证和错误处理,以及JSON格式的真实请求和响应示例。除了书面参考外,我们还希望有一个互动测试页面,供合作开发者输入自己的密钥,发送示例请求,并在浏览器中直接查看实时响应。
我们可以提供访问暂存环境、现有内部笔记以及与我们的后端开发者直接沟通以澄清复杂端点的机会。理想的候选人应具有REST API、JSON、身份验证方案(如令牌或API密钥)以及构建互动文档工具的实际经验。请分享您之前撰写的文档示例,以及预计的时间表。
交付物:
— 所有端点和参数的结构化参考
— 每个方法的请求和响应示例
— 合作开发者的互动测试页面
— 新集成者的简短入门指南
这项工作涵盖所有公共端点:清晰描述每个方法的功能,所需和可选参数的完整细分,包括类型和默认值,身份验证和错误处理,以及JSON格式的真实请求和响应示例。除了书面参考外,我们还希望有一个互动测试页面,供合作开发者输入自己的密钥,发送示例请求,并在浏览器中直接查看实时响应。
我们可以提供访问暂存环境、现有内部笔记以及与我们的后端开发者直接沟通以澄清复杂端点的机会。理想的候选人应具有REST API、JSON、身份验证方案(如令牌或API密钥)以及构建互动文档工具的实际经验。请分享您之前撰写的文档示例,以及预计的时间表。
交付物:
— 所有端点和参数的结构化参考
— 每个方法的请求和响应示例
— 合作开发者的互动测试页面
— 新集成者的简短入门指南
文本和翻译 现金, 银行转账