swagger-mock-fe

1.1.0 • Public • Published

Swagger Mock FE

分析Swagger文档,输出相应的mock数据,并启动node服务,供前端开发时调试使用,提高前端开发效率,支持跨域访问

安装

npm install --save-dev swagger-mock-fe

用法

const swaggerMock = require('swagger-mock-fe');
new swaggerMock({
    host: '10.xxx.xxx.15',//此处是swagger文档服务ip
    projectName: 'test',
    mockPos: '../../',
    headers: {
        'host': '域名'
    }
});

参数

Attributes forma describe
host string swagger文档地址ip,必填
hostname string swagger文档访问域名,如果此处传入任何值,host字段则不生效
path string swagger文档数据请求路径,在swagger文档页面可以找到
port integer swagger文档地址端口号, 默认80
projectName string 项目名,默认值swaggermock
mockPort string 本地mock服务启动后的端口,默认为3001
mockPos string mock文档生成的相对位置,默认为./
headers object 一般用于host的配置

运行

将上面的代码放置于安装了依赖后的项目中的某个js中,如run.js,执行如下命令

node run.js

使用

访问如下形式的真实地址,即可看到模拟数据,端口默认为3000,可配置为其他值

http://127.0.0.1:3000/xxx/xxx/xxx.do

所有的接口路径请求,都生成在${projectName}/urlsReal.js里

Package Sidebar

Install

npm i swagger-mock-fe

Weekly Downloads

11

Version

1.1.0

License

MIT

Unpacked Size

15.6 kB

Total Files

5

Last publish

Collaborators

  • shelly0702