Swagger

第一种

pom

        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
        </dependency>

application.yml

swagger:
 print-init: true
 enabled: true
 title: Api服务文档
 version: 1.0.0
 base-package: com.controller

启动类

/**
 * @creater dada
 * @time 2021/1/29 11:14
 * @description
 */
@EnableDiscoveryClient
@SpringBootApplication
@Configuration
@EnableSwagger2Doc
@ComponentScan({
        "com.*",
})
public class UserApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class,args);
    }
}

controller

 * <h3>project2</h3>
 * <p></p>
 *
 * @author : dada
 * @date : 2021-01-31 11:48
 */
@Api(value = "API - UserController -web", tags="controller-for-one")
@RestController
@RequestMapping(value = "api/v1/uses")
public class UserController {

    @ApiOperation(value = "测试", notes = "测试")
    @RequestMapping(value = "", method = RequestMethod.GET)
    public String test(){
        return "测试";
    }
}

效果图

第二种

pom

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

config

/**
 * <h3>project2</h3>
 * <p>Swagger配置</p>
 *
 * @author : dada
 * @date : 2021-01-31 11:40
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(this.apiInfo())
                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(false)
                .select()
                .paths(doFilteringRules())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("Api服务文档")
                .termsOfServiceUrl("服务条款")
                .contact(new Contact("", "",""))
                .version("1.0")
                .build();
    }
    /**
     * 设置过滤规则
     * 这里的过滤规则支持正则匹配
     *
     * @return
     */
    private static Predicate<String> doFilteringRules() {
        return or(
                regex("/api/v.*")
        );
    }
}

启动类

/**
* @creater dada
* @time 2021/1/29 11:14
* @description
*/
@EnableDiscoveryClient
@SpringBootApplication
@Configuration
@EnableSwagger2Doc
@ComponentScan({
     "com.*",
})
public class UserApplication {
 public static void main(String[] args) {
     SpringApplication.run(UserApplication.class,args);
 }
}

controller同上

效果