ssm集成swagger过程记录(超详细)

这是我的web层的目录,红框里的是需要改动的文件。
在这里插入图片描述
第一步:在web层的pom.xml文件里,添加所需jar包的依赖。
备注:添加之前可以先搜索一下,查看是否已经有了。
在这里插入图片描述
第二步:在源码目录下创建config的包,在包里创建SwaggerConfig文件。我的路径是com.schoolface.shkt的同级,具体可参考此博客的第一张图。

package com.schoolface.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Created by Silvia on 2018/11/20.
 */
@Configuration
@EnableSwagger2
@EnableWebMvc
@ComponentScan(basePackages = "com.schoolface.shkt.controller")
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXX项目接口文档")
                .description("XXX项目接口测试")
                .version("1.0.0")
                .termsOfServiceUrl("")
                .license("")
                .licenseUrl("")
                .build();
    }
}

第三步:在springmvc的配置文件springmvc.xml文件中配置swagger。
备注:(1)最后一句和参考博客不同;(2)其中的base-package和class分别为controller层和swagger配置文件的路径,根据实际填写即可。
在这里插入图片描述
第四步:在web.xml文件中,添加如下内容。使请求都经DispatcherServlet处理。
备注:一般这个配置在web.xml中已经存在
在这里插入图片描述
第五步:确保controller层有相关的注解,@ApiOperation等。

第六步:在WEB-INF包下,新建swagger包,然后把swagger-ui相关的东西复制到swagger包下。swagger-ui云盘分享如下。
链接:https://pan.baidu.com/s/1hRoTuHBvE0V9QcfhDFojZg
提取码:npfb
找这个包的过程有些曲折,好多都不能用,似乎是版本的问题。
第七步:运行项目,在浏览器中访问
在这里插入图片描述

至此就完成了。在一些小细节上可能有些出入,但大体思路如此。欢迎读者交流。
参考博客:
https://www.cnblogs.com/jtlgb/p/6734177.html
https://blog.csdn.net/twomr/article/details/77101092

  • 2
    点赞
  • 23
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

卡夫卡的熊kfk

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值