|
所在平台: Udemy |
课程主页: https://www.udemy.com/course/learn-api-technical-writing-2-rest-for-writers/
课程评论：没有评论
Coursera 课程总结：学习 API 技术写作 2：RESTful API 写作指南 本课程是技术写作系列课程的第二部分，专注于教授如何撰写 RESTful API 文档。建议在完成“学习 API 技术写作：JSON 和 XML 写作指南”课程后再进行学习，除非您已对 JSON 和 XML 及其文档化方法非常熟悉。 **课程概述：** * **面向人群：** 主要面向技术写作者，无需编程经验。具备编程经验并希望深入了解 RESTful API 的写作者也能从中受益。 * **API 简介：** API（应用程序编程接口）是软件系统之间进行通信的桥梁，API 文档是一个快速发展的领域。能够理解和解释 API 以便开发者使用的技术写作者需求旺盛，且能够获得高薪。 * **REST 简介：** REST（Representational State Transfer）是一种流行的 Web API 风格，用于设备与服务器之间的数据通信。API 请求和响应的不同部分包含不同的数据，本课程将详解这些部分及其文档化方法。 **课程内容：** 完成本课程后，您将能够理解 RESTful API 的概念，并掌握如何阅读和编写 RESTful API 的请求和响应文档。课程包含： * **12 个视频：** * 提供 RESTful API 的背景信息。 * 分解 RESTful API 请求的各个组成部分，并提供示例。 * 展示 RESTful API 文档的实时、讲解式写作过程。 * 介绍 RESTful API 的身份验证和授权。 * **7 个实践练习：** 引导您完成 RESTful API 请求的制作和文档撰写。 * **7 个简短测验：** 帮助巩固学习内容。 * **资源：** * 每个视频讲座的 PowerPoint 演示文稿。 * 可用于 RESTful API 参考文档的 Microsoft Word 模板。 **课程时长：** 预计完成时间约为 3 小时 30 分钟，具体取决于学员的练习速度。
This is the second in a series of courses for technical writers who want to learn how to write API documentation. The first course is called "Learn API Technical Writing: JSON and XML for Writers", and it is recommended that you first take that course, unless you are very familiar with JSON and XML, and how to document them.This course teaches how to document REST APIs. No programming experience is required, but technical writers with programming experience who want to know more about REST APIs will still find it useful.What are APIs?APIs (Application Program Interfaces) define how software systems talk to each other, and API documentation is a rapidly growing field. There is a strong need for writers who can understand APIs and explain them so that software developers can understand how to use them. API writers get to be in on the cutting edge of technology in high-paying positions.What is REST?REST (Representational State Transfer) is a popular style of web API, and it's used to communicate data between devices and servers. Different data is contained in different parts of the API requests and responses, and this course explains what those different parts are and how to document them.What is in This Course?By the end of the course, you will understand what REST is and how to read and document REST requests and responses. In this course you'll find:12 videos that:Provide background information on REST APIsBreak down REST requests into their various pieces with examplesShow real-time, narrated writing of REST documentationProvide overviews of authentication and authorization for REST7 hands-on exercises to lead you through making and documenting REST requests 7 short quizzes to keep you on your toesPowerPoint presentations as a resource for every video lectureA Microsoft Word document you can use as a template for REST reference materialThe course takes approximately 3 hours and 30 minutes to complete, depending on how fast you are with the exercises.
