SSM项目集成Swagger2#私藏项目实操分享#

2021年11月24日 阅读数:2
这篇文章主要向大家介绍SSM项目集成Swagger2#私藏项目实操分享#,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。

第一步:添加Maven依赖

<!--        项目文档:仅仅测试环境使用,产品环境会删除掉-->
<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>

注意:swagger的版本号不要设置为3.0.0,不然会报错。html

第二步:编写Swagger配置文件

@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()).select()
                //扫描指定包中的swagger注解
                .apis(RequestHandlerSelectors.basePackage("com.hc.controller"))
                //扫描全部有注解的api,用这种方式更灵活
                // .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("项目展现平台 API")
                .description("项目展现平台API接口文档")
                .termsOfServiceUrl("https://www.hcshow.online/")
                .license("369950806@qq.com")
                .version("1.0.0")
                .build();
    }

}

第三步:修改springmvc.xml

将第二步中的Swagger配置文件添加到其中:java

<!-- 将自定义的swagger配置类加载到spring容器 -->
<bean class="com.hc.config.SwaggerConfig"/>

<!-- 配置swagger静态资源不被拦截 -->
<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>

运行项目,查看结果

网址:http://localhost/projshow/swagger-ui.html#/web

结果:
在这里插入图片描述spring