Swagger 自动生成 Dubbo 服务的接口文档,以及测试调用

点击上方“芋道源码”,选择“设为星标

管她前浪,还是后浪?

能浪的浪,才是好浪!

每天 8:55 更新文章,每天掉亿点点头发...

源码精品专栏

 
  • 1. 概述

  • 2. Swagger Dubbo

  • 3. 接入 Knife4j 作为 Swagger UI 界面

  • 4. 接入 YApi 统一管理

  • 666. 彩蛋


1. 概述

在使用 SpringMVC 构建 HTTP API 时,我们可以通过 Swagger 自动生成 HTTP 接口文档,通过 Swagger UI 界面上进行 HTTP 接口调试。如下图所示:

Swagger HTTP 界面

秃头提示:对 Swagger 不太了解的胖友,可以去阅读下艿艿写的 《芋道 Spring Boot API 接口文档 Swagger 入门》 文章。

开发体验杠杠的好!但是在使用 Dubbo 构建 RPC API 时,简直想要自闭。常常面临的痛苦是:

  • 隔壁团队的老王,不肯给 Dubbo 写接口文档,只能从他的 Dubbo API 的 jar 包中寻寻觅觅想要的接口,贼不方便~

  • 自己编写的每个 Dubbo API 接口,都需要写个 Controller 或者 Test 类去调用测试,接口调试非常麻烦~

在一个逐步自闭到要爆炸的下午,艿艿做了一波 Dubbo 接口文档与接口调试的调研,想要尝试这块的痛点。结果比想象中顺利且简单,这不趁着这无聊到抠脚的周末,整理下分享给胖友。

  • 5
    点赞
  • 25
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
Swagger 接口文档可以用于自动生成接口测试的 YAML 文件,具体步骤如下: 1. 在 Swagger UI 中找到要测试接口,并点击 "Try it out" 按钮。 2. 填写测试需要的参数,并点击 "Execute" 按钮。 3. 点击 "Code" 按钮,选择 "Shell"。 4. 复制代码,并粘贴到一个文本编辑器中保存为 YAML 文件。 YAML 文件中包含了测试所需的请求参数、请求方法、请求头等信息,可以通过自动测试工具读取并执行测试。 示例代码如下: ```python import requests import yaml # Swagger 文档地址 SWAGGER_URL = 'http://your.swagger.host/swagger.json' # 发送 GET 请求,获取 Swagger 文档 response = requests.get(SWAGGER_URL) # 解析 Swagger 文档中的接口信息 if response.status_code == 200: swagger_doc = response.json() paths = swagger_doc.get('paths', {}) for path, methods in paths.items(): for method, info in methods.items(): # 获取接口的 URL url = f'{SWAGGER_URL.rstrip("/")}{path}' # 获取接口的请求方法 http_method = method.upper() # 获取接口的请求参数 parameters = info.get('parameters', []) # 获取接口的请求头部信息 headers = {} if 'headers' in info: for header in info['headers']: headers[header['name']] = header['description'] # 构造测试用例 test_case = { 'name': f'{http_method} {url}', 'request': { 'url': url, 'method': http_method, 'headers': headers, 'params': {} } } # 将请求参数添加到测试用例中 if parameters: for param in parameters: if 'name' in param: test_case['request']['params'][param['name']] = param.get('example') # 将测试用例转换为 YAML 格式并输出到文件中 with open(f'{http_method}_{path.replace("/", "_")}.yml', 'w') as f: yaml.dump(test_case, f, default_flow_style=False) else: print(f'Failed to get Swagger document. Status code: {response.status_code}') ``` 在上述代码中,我们使用 `requests` 库向 Swagger 文档的 URL 发送 GET 请求,获取 Swagger 文档的 JSON 数据。然后,解析 JSON 数据,获取每个接口的 URL、请求方法、请求参数和请求头信息等信息。最后,根据接口信息构造测试用例,并将测试用例转换为 YAML 格式并输出到文件中。你可以根据需要对测试用例进行扩展和优化。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值