Skip to content

Latest commit

 

History

History
81 lines (70 loc) · 2.63 KB

README.md

File metadata and controls

81 lines (70 loc) · 2.63 KB

mica-swagger 组件

说明

对 swagger 和 knife4j 的封装，方便使用。

注意: 添加 @Api 注解的控制器会自动暴露给 swagger。

使用

maven

<dependency>
  <groupId>net.dreamlu</groupId>
  <artifactId>mica-swagger</artifactId>
  <version>${version}</version>
</dependency>

gradle

compile("net.dreamlu:mica-swagger:${version}")

配置

基础配置

配置项 默认值 说明
mica.swagger.enabled true 是否开启 swagger，默认：true
mica.swagger.title 标题，默认：XXX服务
mica.swagger.description 详情，默认：XXX服务
mica.swagger.version V1.0 版本号，默认：V1.0
mica.swagger.contact-email 组织邮箱
mica.swagger.contact-url 组织url
mica.swagger.contact-user 组织名
mica.swagger.headers 全局统一请求头

oauth2 认证配置

配置项 默认值 说明
mica.swagger.oauth2.enabled false 开启Oauth2，默认：false
mica.swagger.oauth2.name oauth2 鉴权策略ID，对应 SecurityReferences ID，默认：oauth2
mica.swagger.oauth2.authorize-url authorize url
mica.swagger.oauth2.client-id-name clientId name
mica.swagger.oauth2.client-secret-name clientSecret name
mica.swagger.oauth2.token-name access_token token name，默认：access_token
mica.swagger.oauth2.token-url token url
mica.swagger.oauth2.scopes oauth2 scope 列表
mica.swagger.oauth2.grant-type authorization_code 授权类型 authorization_code、client_credentials、implicit、password
mica.swagger.oauth2.path-patterns 需要开启鉴权URL的正则，默认：/**

api key 认证配置

配置项 默认值 说明
mica.swagger.authorization.enabled false 开启Authorization，默认：false
mica.swagger.authorization.name Authorization 鉴权策略ID，对应 SecurityReferences ID，默认：Authorization
mica.swagger.authorization.key-name TOKEN 鉴权传递的Header参数，默认：TOKEN
mica.swagger.authorization.path-patterns 需要开启鉴权URL的正则，默认：/**

使用

注意: 添加有 @Api 注解的控制器才会自动暴露给 swagger。

/**
 * demo 服务
 *
 * @author L.cm
 */
@Validated
@RestController
@Api("demo服务")
@RequiredArgsConstructor
public class DemoController {
	private final AccountService accountService;

	@ApiOperation("demo")
	@GetMapping("/demo")
	public R<AccountVO> demo() {
		return accountService.getAccount();
	}

}