README
generator-singularity-swagger-api
一款基于 Yeoman 的swagger 接口代码生成器 ,借助这个软件包,可以生成一个访问swagger api 的类.
安装
需要同时安装Yeoman 和 generator-singularity-swagger-api
npm install -D yo
npm install -D generator-singularity-swagger-api
使用
yo singularity-swagger-api
输入提示
- ?请输入swagger地址,如:http://localhost:8080/ (http://localhost:8080/) 根据地址访问swagger接口数据
- ?请输入请求类地址 (src/utils/request.js) 请求类文件路径
- ?请输入输出文件位置 (src/utils/api/) 文件输出位置
可通过命令行直接穿参
yo singularity-swagger-api --swaggerUrl=http://localhost:8080 --outputFile=src/utils/api/ --requestPath=src/utils/request.js
参数
- swaggerUrl 后台链接地址
- outputFile api文件保存路径
- requestPath 请求累访问路径
生成代码示例
'use strict';
Object.defineProperty(exports, '__esModule', { value: true });
// @ts-ignore
var request_js_1 = require('../request.js');
/**
* TCBA api
* TCBA API工具
* Fri Dec 25 2020 10:59:32 GMT+0800 (China Standard Time)
*/
var RequireApi = /** @class */ (function () {
function RequireApi() {}
/**
* 清空未读通知
* -
*/
RequireApi.AnnouncementCleanNotRead = function (body) {
return request_js_1.default.connection('post', '/Announcement/CleanNotRead', body);
};
/**
* 获取通知列表
* -
*/
RequireApi.AnnouncementList = function (query) {
return request_js_1.default.connection('get', '/Announcement/List', query);
};
/**
* 查询未读通知数量
* -
*/
RequireApi.AnnouncementNotRead = function (query) {
return request_js_1.default.connection('get', '/Announcement/NotRead', query);
};
return RequireApi;
})();
exports.default = RequireApi;
使用
import RequireApi from '../../utils/api';
RequireApi.AnnouncementCleanNotRead({}).then(res => { console.log(res)})