swagger-editor的安装

  • swagger-editor应用的yaml语法,有定义变量和数据结构,不知道可以参见其现身说法
  • 设置步骤:

    • 下载swagger-editor
      git地址
    • 运作npm run build生成可运行的保证

      • window注意事项:

      • 夺掉package.json文件中scripts节点的prebuild功能,不然会提示
        rm -rf dist/**
        无效,看出这是去除生成包的文本,可以手动删除或自己改变下命令。

      • 又改.eslintrc.js文件,主要是修正linebreak-style的征方式

        module.exports = {
          extends: 'google',
          quotes: [2, 'single'],
          globals: {
            SwaggerEditor: false
          },
          env: {
            browser: true
          },
          rules:{
            "linebreak-style": ["error", "windows"]
          }
        };
        

  • 搭了rules节点,以上是.eslintrc.js完整的布置

  • 输入
    .\node_modules\.bin\http-server即可打开,然后访问这服务器的8080端口就好了。

json 1

swagger-ui的安装

  • 显swagger-editor生成的api文档,api文档格式可以是yaml或json。
  • 安装步骤:

    • 下载swagger-ui
      git地址
    • 区区种配备方式:
      • 先是种植:可以直接将dist文件夹着情节复制到某某网站目录下要创造一个初的站点为足以,这里发出一致效仿默认的swagger-ui的默认皮肤。
      • 第二种:
        • 运作cnpm install 安装具有因包
        • 运行gulp serve
        • 走访本机的8080端口,如果是多个http-server,需要由定义http-server的端口,在gulpfile.js文件中落实

    gulp.task(‘connect’, function() {
    connect.server({

    root: 'dist',
    livereload: true,
    port:8888
    

    });
    });

  • 可以增加打印功能,用于导出api文档为pdf格式的。方便传阅。

json 2

相关文章

网站地图xml地图