Just-API 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00537/article/details/141988800

Just-API 项目教程

just-api:boom: Test REST, GraphQL APIs项目地址:https://gitcode.com/gh_mirrors/ju/just-api

1. 项目的目录结构及介绍

just-api/
├── bin/
│   └── just-api
├── docs/
│   ├── getting-started.md
│   ├── basic-concepts.md
│   ├── cli-reference.md
│   ├── features.md
│   ├── reporters.md
│   └── examples.md
├── lib/
│   ├── core/
│   ├── reporters/
│   └── utils/
├── specs/
│   └── starwars_service.yml
├── .gitignore
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

目录结构介绍

bin/: 包含项目的可执行文件 just-api，用于启动测试。
docs/: 包含项目的文档文件，包括入门指南、基本概念、CLI 参考、功能介绍、报告生成和示例。
lib/: 包含项目的核心代码，包括核心模块、报告生成模块和工具模块。
specs/: 包含测试规范文件，例如 starwars_service.yml，用于定义 API 测试。
.gitignore: 指定 Git 忽略的文件和目录。
LICENSE: 项目的开源许可证文件。
package.json: 项目的 npm 配置文件，包含依赖项和脚本。
README.md: 项目的介绍和使用说明。
yarn.lock: 锁定依赖项版本的文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，文件名为 just-api。该文件是一个可执行脚本，用于启动 Just-API 测试框架。用户可以通过命令行运行该文件来执行测试。

启动命令示例

./node_modules/.bin/just-api

3. 项目的配置文件介绍

项目的配置文件主要位于 specs/ 目录下，例如 starwars_service.yml。该文件定义了 API 测试的规范，包括请求路径、方法、响应状态码、响应头、响应 JSON 数据等。

配置文件示例

meta:
  name: Star Wars suite
configuration:
  scheme: https
  host: swapi.co
  base_path: /api
specs:
  - name: get Luke Skywalker info
    request:
      path: /people/1/
      method: get
    response:
      status_code: 200
      headers:
        - name: content-type
          value: application/json
      json_data:
        - path: $.name
          value: Luke Skywalker