restful Api 风格契约设计器:Swagger-editor和swagger-ui的应用
时间:2022-04-22
本文章向大家介绍restful Api 风格契约设计器:Swagger-editor和swagger-ui的应用,主要内容包括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.binhttp-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格式的。方便传阅。
- oracle表空间不足相关问题解决办法
- 手工打造分布式爬虫
- (64) 常见文件类型处理: 属性文件/CSV/EXCEL/HTML/压缩文件 / 计算机程序的思维逻辑
- org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter与org.apache.struts2.dispatcher.
- Python协程演进过程
- Android TV开发简介
- (59) 文件和目录操作 / 计算机程序的思维逻辑
- Rdseed与SAC的安装
- Python爬虫大战京东商城
- (77) 异步任务执行服务 / 计算机程序的思维逻辑
- Unity Android Plugin开发指南
- Python还能做这个?真的好棒棒耶!
- java中Comparator的用法
- Python爬虫之豆瓣音乐及糗事百科
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- 单细胞转录组基础分析七:差异基因富集分析
- 定位权限请求时易犯的错误小结
- NSOperationQueue队列中操作依赖相关思考
- 单细胞转录组高级分析一:多样本合并与批次校正
- 10元最多可喝多少瓶啤酒?(不可借酒+可借酒,swift语言实现)
- 单细胞转录组高级分析二:转录调控网络分析
- 关于数组内元素是否会被改变的思考
- 排序之选择排序实现(swift)
- 去除友盟等第三方SDK失败的解决办法(clang: error: no such file or directory:xx)
- iOS踩坑之多代理模式使用注意
- 单细胞转录组高级分析三:细胞通讯分析
- 单细胞转录组高级分析四:scRNA数据推断CNV
- 0808-7.1.1-如何在CDP7.1.1指定Hive SQL的资源池队列
- iOS多线程之GCD、OperationQueue 对比和实践记录
- singleR的7个数据库文件下载失败的解决方案