lzh-1.8-swagger-spring-boot-starter

lzh-1.8-swagger-spring-boot-starter 是一个用于简化 Spring Boot 项目中 Swagger 集成的开源启动器库。它提供了一种便捷的方式来配置和使用 Swagger，以生成和展示 RESTful API 的文档。

特性

• 快速集成 Swagger2 和 Swagger Bootstrap UI。
• 支持多组 API 文档配置。
• 提供全局操作参数配置，方便设置通用的请求参数。
• 支持基于包扫描的接口筛选。
• 可配置 API 信息，如标题、描述、版本、许可证、联系人等。

使用说明

1. 将 lzh-1.8-swagger-spring-boot-starter 添加到你的 Spring Boot 项目依赖中。
2. 在 application.yml 或 application.properties 中进行配置。
3. 启动项目后，访问 /swagger-ui.html 或 /doc.html 查看 API 文档。

配置属性

以下是一些支持的配置项：

• lzh.swagger.enabled：启用或禁用 Swagger。
• lzh.swagger.host：API 的主机地址。
• lzh.swagger.docket：配置多个 Docket 组，每个组可以有不同的标题、描述、包路径等。
• lzh.swagger.global-operation-parameters：配置全局请求参数。

示例配置

lzh:
  swagger:
    enabled: true
    host: "localhost:8080"
    docket:
      group1:
        title: "Group 1 APIs"
        desc: "APIs for group 1"
        version: "1.0"
        base-package: "com.lzh.controller.group1"
      group2:
        title: "Group 2 APIs"
        desc: "APIs for group 2"
        version: "1.0"
        base-package: "com.lzh.controller.group2"
    global-operation-parameters:
      - name: "Authorization"
        desc: "Bearer Token"
        model-ref: "string"
        parameter-type: "header"
        require: true

构建与运行

1. 确保你已经安装了 Java 和 Maven。

2. 克隆仓库到本地：

   git clone https://gitee.com/coding_13/lzh-1.8-swagger-spring-boot-starter.git

3. 构建项目：

   mvn clean package

4. 将生成的 JAR 包添加到你的 Spring Boot 项目依赖中，并运行项目。

项目结构

• LzhSwaggerConfig：Swagger 的主配置类，负责创建 Docket 实例。
• SwaggerProperties：用于定义和读取 Swagger 的配置属性。
• LzhRequestHandlerSelectors：自定义的请求处理器选择器，支持按包路径过滤 API。

贡献者指南

欢迎贡献代码！请遵循以下步骤：

1. Fork 仓库。
2. 创建新分支。
3. 提交你的修改。
4. 编写清晰的提交信息。
5. 提交 Pull Request 并等待审核。

许可证

该项目遵循 MIT 许可证。详细信息请参阅 LICENSE 文件。