Postman之documentation

 

 

• API documentation介绍

Postman的API文档特性允许您在格式优美的web页面中共享公共或私有的API文档。

Postman会为您的Collections实时自动生成并托管基于浏览器的API文档。

每个集合都有一个私有和公共文档视图，Postman从服务器中的同步数据生成该视图。

 

 

• 私有文档视图

要访问团队文档的私有视图，请到侧边栏并单击要查看的Collection中的>图标。然后单击“View in web”以生成集合的文档。

 

 

 

• 公有文档视图

当你发布了你的文档，你可以使用公有链接访问你的文档。

公有链接在你的文档发布后就会显示。在私有文档视图的“Published”下拉菜单中也可以访问公有文档。

 

 

• 创建文档的方式

    1.点击Postman 顶部工具栏New button

    2.点击API Documentation

    3.两种方式：一种新建一个api接口，一种是使用当前的workspace中的collection

    4.我选择了Collection的方式

    5.点击Create，生成documentation url，通过图中URL 访问documentation