通过使用dredd测试框架，可以测试已经发布的API可以正常调用，返回的数据格式一致。

一、安装

没有安装nodejs的请先安装nodejs，https://nodejs.org/en/download/
npm install -g dredd

二、编写API文档（Swagger）

新建一个名为api.yaml的文件，内容如下（注意：dredd测试使用的yaml文件中换行不能有\r, 如果有，需要去掉，否则报错）：

swagger: '2.0'
info:
  title: 备件盘点
  description:  |
    备件盘点相关操作  
    初始化 - 查询盘点单 - 查询详情 - 查询明细  
    查询备件库存 - 生成盘点单（针对备件）- 查询全部明细 - 修改盘点单（针对备件）- 作废  
    查询库区 - 查询库位 - 生成盘点单（根据库区库位）- 修改盘点单（根据库区库位）  
    录入 - 审批通过 / 驳回 - 库存覆盖  

    盘点单状态流转  
    新建 -> 作废  
    新建 -> 已结果录入  
    已结果录入 -> 新建/审批通过  
    审批通过 -> 已库存覆盖  
  version: "1.0.0"
host: localhost:8100
schemes:
  - https
basePath: /api
produces:
  - application/json
paths:
  /orders/init:
    get:
      summary: 盘点单界面初始化数据
      tags:
        - InventoryOrder
      responses:
        200:
          description: 出库界面初始化数据
          schema:
            required:
              - payload
            properties:
              message:
                type: string
              payload:
                $ref: '#/definitions/InventoryOrderInit'
definitions:
  Warehouses:
    description: 仓库列表
    type: array
    items:
      required:
        - id
        - name
      properties:
        id:
          type: integer
          minimum: 1
          description: 仓库Id
        name:
          type: string
          description: 仓库名称
  InventoryOrderInit:
    description: 检验界面初始化数据
    required:
      - warehouses
    properties:
      warehouses:
        $ref: '#/definitions/Warehouses'

三、测试

需要将提供API的服务启动，然后执行 dredd api.yaml http://localhost/8100

四、Dredd的限制

（1）api.yaml中换行不能有\r字符，所有\r字符需要去掉；
（2）通过Body传输数据时，不要忘记设置consumes为application/json；
（3）PathVariable的变量，在api.yaml中声明的时候添加x-example:’1’样例值；
（4）在query中集合暂时不支持array格式，需要统一调整为string，原因：可能dredd在解析发送请求时不认识collectionFormat；
（5）isDesc设置default:false不起作用，且使得测试报错，设置为true或者为”false”（”false”的话，swagger editor又通不过）；
（6）pageIndex 设置default:0不起作用，设置为”0”可以，但swagger editor又通不过，原因：dredd在解析default值时可能有问题导致（5）、（6）问题的存在；
（7）API中定义的number类型的数据，后台服务不能返回null，否则Dredd会认为返回的数据错误；

五、指定Dredd测试数据

可以通过使用hooks的方式，来指定测试数据，例如：

var hooks = require('hooks');
hooks.beforeAll(function (transaction, done) {
    
  done();
});
hooks.beforeEach(function (transaction, done) {
    
  done();
});
hooks.before('InventoryOrder > /api/orders/{
    id} > 查询盘点单详情 > 200 > application/json', function(transaction, done) {
    
  transaction.request.uri="/api/orders/2";
  transaction.id="GET /api/orders/2";
  transaction.fullPath="/api/orders/2"; // 真正请求的URI，原来的id为1，现在修改为2
  done();
});
hooks.before('InventoryOrder > /api/orders > 生成盘点单（针对备件） > 201 > application/json', function(transaction, done) {
    
  transaction.request.body="{
    \n  \"warehouseId\": 1,\n  \"storageAreaType\": 2,\n  \"details\": [\n    {
    \n      \"sparePartId\": 74412137,\n      \"locationId\": 28592609\n  },\n    {
    \n      \"sparePartId\": 97511009,\n      \"locationId\": -86719670\n    },\n    {
    \n \"sparePartId\": 45231706,\n      \"locationId\": -28747123\n    }\n  ],\n  \"remark\": \"ad nulla\",\n  \"creator\": \"牛凡\"\n}";// 修改POST请求，body的内容
  done();
});