提高生产率swagger接口文档映射生成前端接口方法

前后端分离时,前端对接口都需要有接口文档,根据接口文档写接口方法,看文档还要去写接口方法基本都是粘贴复制,把这个机械的任务解除了
我们可以根据swagger接口文档,前端来自动生成接口方法

根据swagger.json文件来npm 生成接口方法

接口信息都截去了
在这里插入图片描述
大概数据结构如下我们主要需要用到的是path里的

path: {
   
	"/api/****/Login": {
   
		"post": {
   
			"tags": [
				"Account"
			],
			"summary": "登录授权",
			"operationId": "Login",
			"consumes": [
				"application/json-patch+json",
				"application/json",
				"text/json",
				"application/*+json"
			],
			"produces": [

			],
			"parameters": [{
   
				"name": "input",
				"in": "body",
				"description": "",
				"required": false,
				"schema": {
   
					"$ref": "#/definitions/**"
				}
			}],
			"responses": {
   
				"200": {
   
					"description": "Success"
				}
			}
		}
	},
}

一、那我们需要做的就是解析这段json然后生成js文件, 首先安装依赖

npm install --save-dev swagger-parser

二、项目根目录下新建文件apigen.js
同时配置npm 命令

"api": "node apigen.js",

在这里插入图片描述
三、根据自身项目常用规则编写apigen.js里的方法
个人习惯常用规则如下

在这里插入图片描述
四、apigen.js 编写如下

const fs = require('fs')
const path = require
  • 3
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
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 格式并输出到文件中。你可以根据需要对测试用例进行扩展和优化。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值