# org.os.springboot.extensions.document

**Repository Path**: weizuxiao911/org.os.springboot.extensions.document

## Basic Information

- **Project Name**: org.os.springboot.extensions.document
- **Description**: SpringBoot拓展/文档
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-27
- **Last Updated**: 2024-03-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SpringBoot文档拓展

## 项目简介

一款开箱即用的SpringBoot自动装配拓展插件。

### Maven坐标

```xml
<dependency>
    <groupId>org.os.springboot.extensions</groupId>
    <artifactId>document</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
```

### 内置集成

- SpringBoot 2.4.4
- Swagger 2.9.2

```xml
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.4</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <java.version>8</java.version>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <skipTests>true</skipTests>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>swagger-bootstrap-ui</artifactId>
        <version>1.9.6</version>
    </dependency>
    <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-annotations</artifactId>
        <version>1.5.20</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>


```

## 使用说明

1. 在项目添加拓展插件依赖；

```xml
<dependency>
    <groupId>org.os.springboot.extensions</groupId>
    <artifactId>document</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>
```

2. 在项目配置文件配置参数。

```yaml
document:
  enable: true                                      # 是否开启文档，默认：false
  swagger:
    title: API文档                                  # 文档名称，默认：API文档 
    description: 文档描述                            # 文档描述，默认：api 文档
    contact:                                        # 联系人，可选
      name: weizuxiao
      url: 
      email: 727897965@qq.com
    termsOfServiceUrl:                              # 服务条款，可选
    license:                                        # 许可证，可选
    license-url:                                    # 许可证链接，可选
    version: 0.0.1                                  # 接口版本，默认：0.0.1
    exclude-regex: /error.*                         # 排除装载成文档的接口，正则表达式，默认：/error.x
    request-handler-token-field: Authorization      # 强制token验证，token字段名，默认：Authorization
    request-handler-token-filter:                   # 强制token验证拦截器配置，可选，url/method均为正则表达式
      - url: /test/*
        method: 
```

## 工作原理

Spring SPI
  
## 其他说明

### 内置已实现swagger资源注册
内置实现`WebMvcConfigurer`接口，已向`ResourceHandlerRegistry`注册swagger可视依赖。

### 配置参数动态刷新解决方案
在项目引入nacos依赖，并启用配置中心。

```xml
<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
```