xyz.migoo.framework.web.config.WebProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of migoo-spring-boot-starter-web Show documentation

spring-web 组件

The newest version!

package xyz.migoo.framework.web.config;

import jakarta.validation.constraints.NotNull;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.servlet.config.annotation.PathMatchConfigurer;

@ConfigurationProperties(prefix = "migoo.web")
@Validated
@Data
public class WebProperties {

    /**
     * API 前缀，实现所有 Controller 提供的 RESTFul API 的统一前缀
     * 
     * 

     * 意义：通过该前缀，避免 Swagger、Actuator 意外通过 Nginx 暴露出来给外部，带来安全性问题
     * 这样，Nginx 只需要配置转发到 /api/* 的所有接口即可。
     *
     * @see MiGooWebAutoConfiguration#configurePathMatch(PathMatchConfigurer)
     */
    @NotNull(message = "API 前缀不能为空")
    private String apiPrefix;

    /**
     * Controller 所在包
     * 

     * 主要目的是，给该 Controller 设置指定的 {@link #apiPrefix}
     * 
     * 因为我们有多个 modules 包里会包含 Controller，所以只需要写到 **.controller.** 这样的层级
     */
    @NotNull(message = "Controller 所在包不能为空")
    private String controllerPackage = "**.controller.**";

    private boolean onlyRest = false;

}