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

在前后端分离的项目中,通过swagger.json文件,前端可以自动化生成接口方法,简化了从接口文档复制粘贴的过程。本文介绍了如何配置和使用npm脚本来实现这一功能,包括解析json、编写自定义规则和利用swagger-js-codegen工具快速生成代码。
摘要由CSDN通过智能技术生成

前后端分离时,前端对接口都需要有接口文档,根据接口文档写接口方法,看文档还要去写接口方法基本都是粘贴复制,把这个机械的任务解除了
我们可以根据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('path')
const parse 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值