@liuit/api-gen
v0.0.2
Published
基于swagger生成API
Readme
swagger代码前端生成生成
一. 本组介绍
作者: 黑肱
邮箱: [email protected]
本组件介绍: 本组件主要提供前端代码生成(models,apis以及xxApis 接口索引),与@liuit/api 集成使用,生成符合@liuit/api要求的API接口,为前端提供一站式网络请求服务。二. 组件安装
yarn add @liuit/api-gen 或者 npm install @liuit/api-gen
三. 使用示例
import {CodeGenUtil} from "@liuit/api-gen"
let token = "xxxx"; // 选填
let url = "http://127.0.0.1:8081/sd/v3/api-docs/uc-api"; // swagger api 接口
/**
* 生成代码 (默认生成代码 在 outputDir/contextPath 目录下 生成(models.ts,apis.ts,index.ts)三个文件)
@param swaggerApiUrl swagger服务API地址
@param token 令牌
@param contextPath 上下文路径(前缀)
@param apiSuffix API后缀 domain+apiSuffix+Api
@param excludePrefix 需要排除的固定前缀(如 /api/gc)
@param outputDir 输出文件夹(可根据模块输出,相对于本地目录。默认本地: auto-code)
*/
CodeGenUtil.genCodeToFile(url, token, "/sd","In","/api/gc","./auto")
/**
* 生成代码 返回 CodeInfo
* @param swaggerApiUrl swagger服务API地址
* @param token 令牌
* @param contextPath 上下文路径(前缀)
* @param apiSuffix API后缀 domain+apiSuffix+Api
* @param excludePrefix 需要排除的固定前缀(如 /api/gc)
*/
CodeGenUtil.genCodeContent(url, token, "/sd","In","/api/gc")
三. 使用示例
参见: https://doc.liuit.com
