ApiBoot - ApiBoot Swagger 使用文档
ApiBoot是一款基于SpringBoot1.x,2.x的接口服务集成基础框架, 内部提供了框架的封装集成、使用扩展、自动化完成配置,让接口开发者可以选着性完成开箱即用, 不再为搭建接口框架而犯愁,从而极大的提高开发效率。
ApiBoot
通过整合Swagger2
完成自动化接口文档生成,只需要一个简单的注解我们就可以实现文档的开启,而且文档上面的所有元素都可以自定义配置,通过下面的介绍来详细了解ApiBoot Swagger
的简易之处。
引入ApiBoot Swagger
在pom.xml
配置文件内通过添加如下依赖进行集成:
<!--ApiBoot Swagger-->
<dependency>
<groupId>org.minbox.framework</groupId>
<artifactId>api-boot-starter-swagger</artifactId>
</dependency>
注意:
ApiBoot
所提供的依赖都不需要添加版本号,但是需要添加版本依赖,具体查看ApiBoot版本依赖
@EnableApiBootSwagger
在添加依赖后需要通过@EnableApiBootSwagger
注解进行开启ApiBoot Swagger
相关的配置信息自动化构建,可以配置在XxxApplication入口类上,也可以是配置类,让SpringBoot
加载到即可。
相关配置
配置参数 |
参数介绍 |
默认值 |
---|---|---|
api.boot.swagger.enable |
是否启用 |
true |
api.boot.swagger.title |
文档标题 |
ApiBoot快速集成Swagger文档 |
api.boot.swagger.description |
文档描述 |
ApiBoot通过自动化配置快速集成Swagger2文档,仅需一个注解、一个依赖即可。 |
api.boot.swagger.base-package |
文档扫描的package |
XxxApplication同级以及子级package |
api.boot.swagger.version |
文档版本号 |
api.boot.version |
api.boot.swagger.license |
文档版权 |
ApiBoot |
api.boot.swagger.license-url |
文档版权地址 |
https://github.com/hengboy/api-boot |
api.boot.swagger.contact.name |
文档编写人名称 |
恒宇少年 |
api.boot.swagger.contact.website |
文档编写人主页 |
http://blog.yuqiyu.com |
api.boot.swagger.contact.email |
文档编写人邮箱地址 |
jnyuqy@gmail.com |
api.boot.swagger.authorization.name |
整合Oauth2后授权名称 |
ApiBoot Security Oauth 认证头信息 |
api.boot.swagger.authorization.key-name |
整合Oauth2后授权Header内的key-name |
Authorization |
api.boot.swagger.authorization.auth-regex |
整合Oauth2后授权表达式 |
^.*$ |
以上是目前版本的所有配置参数,大多数都存在默认值,可自行修改。
整合ApiBoot Security Oauth
如果你的项目添加了Oauth2
资源保护,在Swagger
界面上访问接口时需要设置AccessToken
到Header
才可以完成接口的访问,ApiBoot Security Oauth
默认开放Swagger
所有相关路径,如果项目内并非通过ApiBoot Security Oauth2
来做安全认证以及资源保护,需要自行开放Swagger
相关路径。
整合ApiBoot Security Oauth
很简单,访问ApiBoot Security Oauth 查看。
携带Token访问Api
启动添加ApiBoot-Swagger
依赖的项目后,访问http://localhost:8080/swagger-ui.html页面查看Swagger
所生成的全部文档,页面右侧可以看到Authorize,点击后打开配置AccessToken
的界面,配置的AccessToken
必须携带类型,如:Bearer 0798e1c7-64f4-4a2f-aad1-8c616c5aa85b
。
注意:通过
ApiBoot Security Oauth
所获取的AccessToken
类型都为Bearer
。
本章源码地址:https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-swagger
- python运用中文注释时报错解决方法
- 分页器常用样式
- 分布式监控系统Zabbix-3.0.3--短信报警设置
- linux下用户操作记录审计环境的部署记录
- open-falcon ---客户机agent操作
- 双拼域名yansuan.com被木雨林收购
- open-falcon ---安装Dashboard时候报错"SSLError: The read operation timed out"
- Flash/Flex学习笔记(37):不用系统组件(纯AS3)的视频播放器--只有8.82K
- Flash/Flex学习笔记(35):如何正确监听Stage对象的事件
- Flash/Flex学习笔记(34):AS3中的自定义事件
- 字符串处理总结(旧)
- 计算某年某月的某一天是星期几的算法
- Flash/Flex学习笔记(33):如何用As3协同Flash CS IDE控制MovieClip实例
- live writer的折腾
- 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 数组属性和方法
- python五十六课——正则表达式(常用函数之search())
- python五十六课——正则表达式(常用函数之findall)
- python五十七课——正则表达式(元字符)
- python五十七课——正则表达式(边界字符)
- python五十七课——正则表达式(多个字符)
- python五十八课——正则表达式(分组)
- python五十八课——正则表达式(替换)
- 配置Tomcat使用https协议(单向认证)
- python五十八课——正则表达式(切割)
- python五十九课——正则表达式的拓展内容
- 配置SVN的hooks功能自动更新代码
- python六十课——高阶函数之map
- python六十一课——高阶函数之reduce
- python六十二课——高阶函数之filter
- Nginx优化配置详解