Postman中文文档——数据格式

2017-08-27 本文已影响258人千夜

数据格式

Postman可以导入或导出集合，环境，全局变量和header预设为文件和链接。

导入和导出Postman数据

Postman可以导入和导出以下格式作为文件或生成的URL。从Postman应用程序导出集合时，导出的文件是一个JSON文件。该文件包含Postman在导入Postman时重新创建集合所需的所有数据（和元数据），或由Newman从命令行界面（CLI）运行集合所使用的所有数据（和元数据）。

集合

导出集合

Postman可以导出两种格式的集合 —— v1和v2。Collection v1和v2都作为JSON文件下载; v2是更多功能和最常用的选择。了解有关v1和v2格式的更多信息。

导出所有Postman数据

从SETTINGS 窗口的数据（Data）选项卡，Postman允许您将所有集合，环境，全局变量和header预设导出到一个JSON文件中。Postman不会导出你的历史记录。您可以将此数据导入Postman。

导入Postman数据

可以从SETTINGS 窗口的数据（Data）选项卡中导入Postman数据，也可以使用标题工具栏中的导入（Import）按钮。使用IMPORT 窗口导入集合，环境，数据转储，curl命令或RAML / WADL / Swagger（v1 / v2）/ Runscope文件。

导入按钮

单击 选择文件夹 （Choose Folders）并上传RAML文件夹。

导入文件夹窗口

恭喜你完成了！Postman将检测所有RAML定义，并将其内部转换为Postman，然后向您显示导入成功d的消息。

确认消息

示例

下载一个RAML示例文件： github-api-v3.raml

导入Swagger

Swagger API定义通常以单个文件的形式存在，因此我们只支持导入单个swagger文件。如果文件夹中有很多不相关的Swagger文件，则可以通过文件夹导入器导入这些文件。

将Swagger文件另存为集合

将包含Swagger定义的存储库克隆到本地计算机。如果你已经把它保存在本地的文件中，那当然可以。
单击导入（ Import）按钮，然后选择导入文件（ Import File）选项卡。如果文件夹中有很多不相关的Swagger文件，则可以通过文件夹导入器导入这些文件。

导入按钮
点击文件并上传Swagger文件。

恭喜你完成了！Postman将检测所有Swagger定义并将其内部转换为Postman，然后向您显示导入成功消息。

确认消息

示例

Swagger 2.0：https： //github.com/OAI/OpenAPI-Specification/tree/master/examples/v2.0

Swagger 1.2：https： //github.com/OAI/OpenAPI-Specification/wiki/Hello-World-Sample

导入WADL

Postman也可以导入WADL规范。虽然所有方面都不受支持，但您可以期待Postman使用的各种参数（集合，文件夹，请求，标头，请求有效载荷）的正确生成。我们正在努力扩展此功能。

示例WADL文件

<application xmlns="http://wadl.dev.java.net/2009/02">
  <resources base="http://example.com/api">
    <resource path="books">
      <method name="GET"/>
      <resource path="{bookId}">
        <param required="true" style="template" name="bookId"/>
        <method name="GET"/>
        <method name="DELETE"/>
        <resource path="reviews">
          <method name="GET">
            <request>
              <param name="page" required="false" default="1" style="query"/>
              <param name="size" required="false" default="20" style="query"/>
            </request>
          </method>
        </resource>
      </resource>
    </resource>
    <resource path="readers">
      <method name="GET"/>
    </resource>
  </resources>
</application>

取自 http://www.nurkiewicz.com/2012/01/gentle-introduction-to-wadl-in-java.html

验证集合JSON文件

要验证JSON文件是否采用正确的集合格式，可以使用我们的文件集合模式。

模式文件位于 http://schema.getpostman.com/json/collection/v1.0.0/collection.json。
相关文档可以在http://schema.getpostman.com/json/collection/v1.0.0/docs/index.html找到。
一切都整齐地存储在GitHub https://github.com/postmanlabs/schemas上。
要查看使用我们的模式和is-my-json-valid （验证器）的数据验证示例，请查看此博客文章。