如何从配置文件设置swagger配置属性

Swagger 是一个用于设计、构建、文档化和使用 RESTful Web 服务的框架。它可以帮助自动生成 API 文档，并提供交互式 API 测试界面。在很多项目中，Swagger 的配置是通过配置文件来设置的，这样可以方便地管理和调整 Swagger 的行为。

基础概念

Swagger 配置文件通常是一个 YAML 或 JSON 文件，其中包含了 Swagger 的各种配置选项，比如 API 的信息、文档的标题和描述、安全配置、路径定义等。

类型

Swagger 配置文件的类型主要有两种：

OpenAPI 规范（以前称为 Swagger 规范）：这是一个 JSON 或 YAML 文件，定义了 API 的所有方面，包括端点、参数、响应等。
Springfox 配置（针对 Spring Boot 项目）：Springfox 是一个库，它可以将 Swagger 注解转换为 OpenAPI 规范，并提供一个可交互的 API 文档。

应用场景

Swagger 配置文件广泛应用于各种需要公开 API 的场景，如：

Web 服务开发
微服务架构
前后端分离的项目

如何设置 Swagger 配置属性

以下是一个简单的 Swagger 配置文件示例（OpenAPI 规范）：

openapi: 3.0.0
info:
  title: 示例 API
  version: 1.0.0
servers:
  - url: http://localhost:8080
paths:
  /hello:
    get:
      summary: 返回一个问候语
      responses:
        '200':
          description: 成功响应
          content:
            application/json:
              schema:
                type: string

在这个示例中：

openapi 指定了 Swagger 规范的版本。
info 包含了 API 的基本信息，如标题和版本。
servers 定义了 API 的基础 URL。
paths 定义了 API 的端点及其操作。

遇到的问题及解决方法

问题： Swagger 文档没有正确显示。

原因：

Swagger 配置文件路径或名称错误。
配置文件中的语法错误。
项目中缺少必要的 Swagger 依赖。

解决方法：

确保 Swagger 配置文件路径和名称正确，并且项目能够找到它。
使用 YAML 或 JSON 验证工具检查配置文件的语法。
确保项目中包含了正确的 Swagger 依赖。例如，在 Maven 项目的 pom.xml 中添加：

<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>