ssm整合swagger(idea)

最新推荐文章于 2021-01-21 09:35:29 发布

Later1996

最新推荐文章于 2021-01-21 09:35:29 发布

阅读量594

点赞数

分类专栏： swagger应用文章标签： java

本文链接：https://blog.csdn.net/Later1996/article/details/107970779

版权

swagger应用专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文介绍了如何在SSM（Spring、SpringMVC、MyBatis）项目中整合Swagger，以实现RESTful API的自动文档生成和测试。通过在pom.xml中添加Swagger依赖，配置相关Java类和XML文件，以及编写测试Controller，最后可以通过http://localhost:8080/swagger-ui.html进行文档查看和接口测试。

摘要由CSDN通过智能技术生成

swagger: swagger是一个规范和完整的框架,用于生成描述调用和可视化的restful风格的web服务.可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试。
ssm+maven整合swagger步骤:
1.在pom.xml中导入swagger所需坐标(注意swagger版本号)

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

2.创建swagger配置类

@Configuration
@EnableSwagger2
@EnableWebMvc
@ComponentScan(basePackages = "com.xx") //需要扫描的包
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.xml

	<!-- 配置swagger的bean -->
	<!-- 将静态资源交由默认的servlet处理 -->
	<mvc:default-servlet-handler/>
	<!-- 向容器自动注入配置 -->
	<context:annotation-config/>
	<!-- 将SwaggerConfig配置类注入 -->
	<bean class="com.mr.config.SwaggerConfig"/>
	<!-- 配置swagger静态资源不被拦截 -->
	<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>
	<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>

修改web.xml

 <servlet-mapping>
        <servlet-name>springMVC</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

controller测试类编写

@Controller
@RequestMapping("user")
@Api(tags = "用户模块")
public class UserController {

    @Autowired
    private UserService userService;


    @RequestMapping(value = "getUserById/{id}",method = RequestMethod.GET,produces="application/json; charset=UTF-8")
    @ResponseBody
    @ApiOperation(value = "根据id获得用户信息",notes = "test")
    @ApiImplicitParam(paramType = "path",name = "id",value = "用户主键",required = true,dataType = "int")
    public User getUserById(@PathVariable("id") Integer id){
        return userService.getUserById(id);
    }