摘要：相关配置配置参数参数介绍默认值是否启用文档标题快速集成文档文档描述通过自动化配置快速集成文档，仅需一个注解一个依赖即可。注意通过所获取的类型都为。
ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架， 内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即用， 不再为搭建接口框架而犯愁，从而极大的提高开发效率。
ApiBoot通过整合Swagger2完成自动化接口文档生成，只需要一个简单的注解我们就可以实现文档的开启，而且文档上面的所有元素都可以自定义配置，通过下面的介绍来详细了解ApiBoot Swagger的简易之处。
引入ApiBoot Swagger在pom.xml配置文件内通过添加如下依赖进行集成：
org.minbox.framework api-boot-starter-swagger
注意：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/ap... |
| 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
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/74054.html
摘要：如果全部使用默认值的情况话不需要做任何配置方式前提项目需要添加数据源依赖。获取通过获取启用在使用格式化时非常简单的，配置如下所示开启转换转换时所需加密，默认为恒宇少年于起宇默认不启用，签名建议进行更换。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架， 内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即...
摘要：的短信服务模块是由阿里云的国际短信服务提供的，支持国内和国际快速发送验证码短信通知和推广短信。前提需要到阿里云控制台申请开通短信服务。如果在阿里云控制台定义的短信模板存在多个参数，可以通过方法来进行挨个添加，该方法返回值为本对象。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架， 内部提供了框架的封装集成、使用扩展、自动化完成配置，让接...
摘要：如下所示不配置默认使用自定义是的概念，用于自定义转换实现，比如自定义格式化日期自动截取小数点等。下面提供一个的简单示例，具体的使用请参考官方文档。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架， 内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选着性完成开箱即用， 不再为搭建接口框架而犯愁，从而极大...
摘要：添加快速集成的对象存储服务，提供常用的文件操作方法，当然也提供自定义扩展，以致于满足绝大数业务场景，并且通过扩展可以实现上传文件进度条下载文件进度条存储空间操作静态网站托管访问日志防盗链分片上传追加上传断点续传等等。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服务集成基础框架， 内部提供了框架的封装集成、使用扩展、自动化完成配置，让接口开发者可以选...
摘要：注意如果你的方法返回对象只有一个资源对象需要映射，可以单独配置使用注解。集合资源加载返回值为集合的示例类型作为返回值时，其中注意必须是对象类型。如果你有想要的使用方式，你就可以提交 ApiBoot Resource Load ApiBoot Resource Load是一款资源与业务完全分离的基础框架，可以整合微服务(Feign、OpenFeign)进行负载均衡读取固定类型、固定所属业...
阅读 2163·2021-11-08 13:13
阅读 1079·2021-10-09 09:41
阅读 1483·2021-09-02 15:40
阅读 3032·2021-08-17 10:13
阅读 2443·2019-08-29 16:33
阅读 3005·2019-08-29 13:17
阅读 3006·2019-08-29 11:00
阅读 3182·2019-08-26 13:40
