栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Swagger文档项目配置

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Swagger文档项目配置

1.配置pom文件,在pom文件中引入swagger的相关依赖。

        
            io.springfox
            springfox-swagger2
            2.9.2
        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        

2.构建swagger配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }

    //基本信息的配置,信息会在api文档上显示
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("java-practice-api文档")
                .description("项目接口文档")
                .termsOfServiceUrl("http://localhost:9001")
                .version("1.0.0")
                .build();
    }
} 

3.在接口层增加对应的注解,这里我就直接使用controller层了

@RestController
@RequestMapping("/test")
@Slf4j
@Api
public class TestController {

    @Autowired
    private UserServiceImpl userService;

    @ApiModelProperty(value = "测试接口")
    @PostMapping("/get")
    public void get() {
        userService.test();
    }

}

4.生成后的效果(访问:http://localhost:9001/swagger-ui.html)

 5.注意,如果出现以下问题

 解决方法:在application.yml增加如下配置即可

spring:
  mvc:
    pathmatch:
      matching-strategy: ANT_PATH_MATCHER

 

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/878163.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号