Jmeter API文档分析

原创

于 2019-01-10 18:52:02 发布 · 2.3k 阅读

CC 4.0 BY-SA版权

本文详细介绍了分析API文档的重要性，回顾了API文档的由来和作用，并提供了项目API文档的下载方法。接着深入解析了API文档的各个关键节点，包括href、items、links、templates、queries和error节点，同时总结了不同类型的查询方式。最后，列举了学院、班级和学生接口的清单示例，便于理解和应用。

为什么要分析API文档？

回顾

首先回顾下之前讲过的API文档由来和作用图

API文档由来：

API文档由来

API文档作用:

API作用

项目API文档下载

1. API文档解析：

1.1 href节点：

作用：href节：为资源的请求地址；-(请求资源集合时的请求地址要与**href相符**)  
      "href":" http://127.0.0.1:8000/api/departments/"

1.2 items节点：

作用：为服务器响应数据时返回的资源属性；
         (请求接口时，返回的资源属性要与items里的属性相符)

"items": [
              {
                "href": "/T01",
                "data": {
                            "dep_id": "T01",
                            "dep_name": "Test学院",
                            "master_name": "Test-Master",
                            "slogan": "Here is Slogan"
                        }
             }
         ]

1.3 Links节点：

作用：为在当下资源下能连接到的直属下一资源
    (比如：A资源直接包含或关联着B、C两个资源，如果访问到A资源时，Links应定为到B和C)

"links": [
            {
            "rel":"classes",
            "href":"http://127.0.0.1:8000/api/departments/T01/classes/ ",
            "prompt": "班级集合"
            }
         ]

1.4 templates节点：

作用：为新增和更新资源时所需要的属性
      (新增和更新资源时所需要的JSON报文属性)

"templates": {
                "data": [
                          {
                            "dep_id": "T01",
                            "dep_name": "Test学院",
                            "master_name": "Test-Master",
                            "slogan": "Here is Slogan"
                          }
                        ]
              }

1.5 queries节点：

作用：为资源支持的查询列表参数名和查询条件
      (资源支持哪些属性可以list查询;支持做查询条件的属性)

"queries": [
             {
                "rel": "search",
                "href":" http://127.0.0.1:8000/api/departments/",
                "prompt": "列表查询",
                "data": [
                            {
                                "name": "$dep_id_list",
                                "value": ""
                            },
                            {
                                 "name": “$dep_name_list”,
                                 "value": ""
                             },
                             {
                                "name": "$master_name_list",