restful Api 风格契约设计器:Swagger-editor和swagger-ui的应用

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端口就可以了。

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格式的。方便传阅。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏运维前线

php7下安装event扩展

php7下安装event扩展 有效安排I/O,时间和信号的扩展 使用可用于特定平台的最佳I/O通知机制的事件,是PHP基础设施的libevent端口。 ...

344100
来自专栏CaiRui

Shell中的$..

$0 这个程式的执行名字 $n 这个程式的第n个参数值,n=1..9 $* 这个程式的所有参数,此选项参数可超过9个。 $# 这个程式的参数个数 $$ 这个程式...

35390
来自专栏积累沉淀

hbase集群安装(1)-ssh安装及配置

安装ssh服务器端 赋予tg用户权限 sudo chown -R tg:tg /software/ ? 查看用户被赋予的权限 ? 1.检查ssh客户端是否安装:...

22750
来自专栏xingoo, 一个梦想做发明家的程序员

公司内网,无法使用yum在线下载,肿么办?

1 配置上网代理   编辑/etc/yum.conf,增加如下属性: proxy=你的代理地址 proxy_user=你的用户名 proxy_passwor...

357100
来自专栏用户画像

Linux安装mariadb

Enter current password for root (enter for none):<–初次运行直接回车

23830
来自专栏FreeBuf

Python编写的开源Struts2全版本漏洞检测工具

0x01 说明: 由于struts2框架频繁爆出漏洞,为方便安全从业人员检测并及时修复,遂将struts历史版本payload整合在一起(ST2-005至ST2...

86460
来自专栏about云

如何通过官网查找hadoop、hbase、hive版本兼容信息

问题导读 1.如何查看hbase与hadoop的兼容? 2.hive是否与所有hadoop兼容? 3.hadoop2.7.1 hbase1.2.x hive...

47480
来自专栏运维小白

克隆虚拟机的注意点

在虚拟机中的 “管理”——>克隆虚拟机 更改虚拟机的IP,配置文件为 /etc/sysconfig/network-scripts/ifcfg-ens32 中 ...

21390
来自专栏西安-晁州

nodejs应用离线安装部署、卸载

公司写的文档,直接粘贴过来了: 本文档提供node应用一键安装、部署、卸载说明,包含对应脚本文件 默认版本: 1、nodejs:v6.11.2.linux-...

41900
来自专栏Aloys的开发之路

Unix/Linux操作系统中如何在sqlplus/rman中使用方向键

默认情况下在Unix/Linux中使用Oracle的sqlplus/rman是无法使用↑↓←→几个方向键进行操作的,要想达到Windows下使用sqlplus/...

22960

扫码关注云+社区

领取腾讯云代金券