Postman高级应用（10）：给！你要的接口文档——发布文档

场景

开发一个项目需要前端和后端的配合，而接口文档则是连接前后端的一个桥梁。接口文档一般由后端驱动完成，当然也可以由前端驱动完成。只要文档一出来，两边都可以同时开干，提高开发效率。你是不是还在烦恼要用什么云文档平台来编写接口说明，完全不需要，因为Postman已经为我们提供了在线文档发布功能。下面，我将告诉大家如何在Postman上预览并发布文档。

在此之前，你最好创建一个Postman帐号并登录，因为之后的章节所介绍的功能都可能要先登录。

实战

1. 首先创建一个集合(collection)，因为集合是文档生成的最小单位。如有需要，可以加上描述，介绍一下这个集合是对应哪一个工程/业务。

2. 在该集合里创建一个请求(request)，我们继续复用之前用过的简单GET请求。添加一些必要的注释，例如params、headers、body等。
   

3. 为该请求添加示例(example)。示例其实很好理解，一般好的接口文档都有成功请求的示例，以及失败时的示例，大家主要关注请求的返回值(response)。一对请求值和返回值合起来才能算一个示例。点击Examples(0)的Add Example添加示例，我们添加一个请求成功的示例。我们在NAME填入成功作为示例名称，在Status填入成功时返回的HTTP状态码，一般为200 OK，