@0xproject/sra-report 中文文档教程

Question

SRA Report

此工具允许您生成报告，详细说明端点的标准中继器 API HTTP 规范合规性。 该工具将执行 Postman collection 运行并将报告打印到控制台或将其保存到磁盘作为 json 文件。 SRA报告还可以输出一个Postman集合文件和Postman环境文件，方便复制和调试使用 Postman 本机应用程序 运行收集。

该工具当前对每个端点执行以下检查：

• application/json Content-Type header validation
• JSON schema validation
• Correct filtering when a query paramater is provided (ex. when querying for a specific maker address, all orders returned have the same maker address that was provided by the query)

即将推出的功能：

• Correct sorting (ex. the /orderbook endpoint should return orders in order of price)
• Tests for pagination
• Tests for the POST /order endpoint
• Tests for failure cases and errors

Installation

yarn add -g @0xproject/sra-report

Options

sra-report
Options:
  --help                      Show help                                [boolean]
  --version                   Show version number                      [boolean]
  --endpoint-url, -e          API endpoint url to test for standard relayer API
                              compliance                     [string] [required]
  --output, -o, --out         The relative path to write the report generated by
                              the collection run, prints to console by default
                                                                        [string]
  --network-id, -n            ID of the network that the API is serving orders
                              from                         [number] [default: 1]
  --environment, --env        The relative path to a postman environment file
                              for the collection run                    [string]
  --export-collection, --ec   The relative path to write the postman collection
                              file used by the collection run           [string]
  --export-environment, --ee  The relative path to write the postman environment
                              file used by the collection run           [string]

Example Usage

Print report to console

sra-report --endpoint-url 'http://api.example.com'

Save a report to disk

sra-report --endpoint-url 'http://api.example.com' --output 'path/to/report.json'

Generate report for an endpoint that serves kovan testnet orders

sra-report --endpoint-url 'http://kovan.api.example.com' --network-id 42

Write Postman collection and environment files for use in the Postman native app

sra-report --endpoint-url 'http://.api.example.com' --export-collection 'path/to/collection.json' --export-environment 'path/to/environment.json'

Run the report using a custom environment

sra-report --endpoint-url 'http://.api.example.com' --environment 'path/to/custom/environment.json'

Custom environments

在开发中测试标准中继 API 端点时，修改 Postman 可能会有用此工具生成的环境文件，以便在收集运行期间使用特定的查询参数。 例如，默认情况下，此工具将从 /orders 端点获取第一个订单，并将该订单的属性用作其余运行的查询参数。 另一个例子是该工具将默认为 WETH 和

为了向该工具提供自定义环境，请执行以下步骤：

1. Export a Postman environment file using the tool: example
2. Open the Postman environment file using your favorite text editor or in the Postman native app
3. Modify the specific values you want
4. Save the environment file and export it if using the Postman native app
5. Run the tool and supply a path to your modified environment file: example

Contributing

我们欢迎来自更广泛社区的改进和修复！ 要报告此包中的错误，请在此存储库中创建一个问题。

请在开始之前阅读我们的贡献指南。

Install dependencies

如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们：

yarn config set workspaces-experimental true

然后安装依赖

yarn install

Build

项 要构建此包和它所依赖的所有其他 monorepo 包，请从 monorepo 根目录运行以下命令：

PKG=@0xproject/sra-report yarn build

或持续重建关于改变：

PKG=@0xproject/sra-report yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test