yml 中配置springfox 访问路径和端口

在 yml 中配置 Springfox 访问路径和端口，可以按照以下方式进行配置：

server:
  port: 8080 # 指定端口号

springfox:
  documentation:
    swagger:
      enabled: true # 开启 Swagger
  swagger-ui:
    path: /api-docs # 访问路径

在上面的配置中，`server.port` 指定了 Spring Boot 应用的端口号，`springfox.documentation.swagger.enabled` 设置为 `true` 开启 Swagger，`springfox.swagger-ui.path` 指定了 Swagger 的访问路径。假设你的应用名称为 `my-app`，那么访问 Swagger 的 URL 就是 `http://localhost:8080/my-app/api-docs`。

相关问题

yml 配置 springfox

YML（YAML）配置Springfox是一种常见的做法，用于自定义Swagger（API文档生成工具）的行为和外观。Springfox是一个用于注解驱动的RESTful API文档生成库，它允许你在YAML文件中详细配置Swagger UI、API路径扫描、数据模型映射等。

以下是使用YAML配置Springfox的基本步骤：

1. 添加依赖：首先在你的Maven或Gradle构建文件中添加Springfox及其相关依赖，例如：

dependencies {
    implementation 'io.springfox:springfox-boot-starter:3.0.0-M5'
}

2. 创建YML文件：通常放在`application.yml`或`application.properties`里，并命名为`swagger-*.yml`，以便Spring Boot自动发现并加载。

3. 配置基础设置：如标题、描述和版本信息，示例：

springfox:
  swagger-ui:
    location: /api-docs
    configUrl: /v2/api-docs
  info:
    title: My API
    description: A sample API using Swagger with Springfox
    version: 1.0.0

4. 配置API路径扫描：指定哪些包或控制器需要扫描以提取API定义，如：

paths:
  include: 
    - '/api/**'
  exclude: []

5. 数据模型映射：如果你有复杂的实体类，可以配置模型别名（model names）：

components:
  schemas:
    User:
      $ref: '#/components/schemas/UserModel'

6. 自定义全局装饰器：可以定义全局的Swagger响应或请求处理器，如认证信息。

springboot在application.yml中配置不使用swagger,不能访问接口和页面

Spring Boot 中的 Swagger 或 API 文档通常是通过添加特定依赖并配置Swagger UI来生成的。如果你不想在 `application.yml` 文件中启用 Swagger 功能，可以按照以下步骤操作：

1. 首先，确认你已经在项目的 `pom.xml` 或者 `build.gradle` 文件中移除了Swagger相关的依赖。例如，Springfox (用于整合Swagger) 的依赖。

<!-- Maven 示例 -->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>版本号</version>
  <!-- 可能需要删除这一行 -->
</dependency>

<!-- Gradle 示例 -->
implementation('io.springfox:springfox-boot-starter') {
    exclude group: 'io.springfox'
}

2. 确保你没有在 `application.yml` 或者 `application.properties` 中配置Swagger的相关信息，比如Swagger UI的端点地址等。通常这些配置项会类似这样：

   springfox:
     ui:
       enabled: false  # 关闭Swagger UI
     openapi:
       info:
         title: My App
         version: 1.0.0

3. 如果你想完全禁用所有REST接口的自动文档，可以在启动类上添加 `@EnableWebMvc` 注解，并覆盖默认的 `WebMvcConfigurerAdapter` 类，阻止Swagger扫描：

   @SpringBootApplication(exclude = WebMvcAutoConfiguration.class)
   public class Application extends WebMvcConfigurer {

       // 添加自定义配置...

       @Override
       public void addResourceHandlers(ResourceHandlerRegistry registry) {
           // 不注册Swagger资源
       }

       @Override
       public void configurePathMatch(PathMatchConfigurer configurer) {
           // 可选，防止匹配Swagger路径
       }
   }