ssm集成swagger详细教程

项目介绍

ssm:spring、springmvc、mybatis

此项目为ssm单体项目,集成了


ssm集成swagger

什么事swagger:【不一一赘述了】

集成的注意事项:

这里是采用ssm+swagger的基础方式,且swagger为2.0以上的版本。

步骤:
  1. 引入依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
有的博客是引入以下的依赖,此依赖为1.0的版本,两种依赖不能同时引入,会出现意想不到的BUG。
<!-- https://mvnrepository.com/artifact/com.mangofactory/swagger-springmvc -->
        <dependency>
            <groupId>com.mangofactory</groupId>
            <artifactId>swagger-springmvc</artifactId>
            <version>1.0.2</version>
        </dependency>

2.下载swagger源码

下载地址: 点击下载swagger

https://github.com/swagger-api/swagger-ui/tree/v2.1.5

3.在web项目webapp下新建文件夹swagger,将下载的源码导入到文件夹下:
c6d6dee33c8ac476fabedcb2a4ce69dd.png
在这里插入图片描述
修改index.html页面:如图所示。
1.0版本可以简写为:”/api-docs”
2.0版本简写为:”/v2/api-docs”

4,编写swagger工具类

package com.zengqiang.utils;

import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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;

/**
 * @Author: iszengziqiang@163.com
 * @Date: 2018/12/30 10:30
 * @Version: 1.0
 * @Desc: TODO
 **/
@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("ssm-single Api Documentation")
                .description("ssm-single项目后台API接口文档")
                .termsOfServiceUrl("https://www.baidu.com/")
                .license("iszengziqiang@163.com")
                .version("1.0.0")
                .build();
    }


}

5,编写API

package com.zengqiang.controller;

import com.zengqiang.student.service.StudentService;
import com.zengqiang.utils.ModelAndView;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @Author: iszengziqiang@163.com
 * @Date: 2018/12/29 14:47
 * @Version: 1.0
 * @Desc: TODO
 **/
@Controller
@RequestMapping("/student")
@Api(value = "student的操作类", description = "学生类")
public class StudentController {
    @Autowired
    private StudentService studentService;

    @RequestMapping(value = "/s.json", method = {RequestMethod.POST, RequestMethod.GET})
    @ResponseBody
    @ApiOperation(value = "根据id查询学生信息", notes = "查询学生", response = ModelAndView.class)
    public ModelAndView selectStudentById(@ApiParam(required = true, value = "学生ID", name = "id") @RequestParam(value = "id") Integer id) {
        return studentService.queryStudentById(id);
    }
}

6,springSwaggerConfig加载到spring容器
在项目的配置文件applicantContext.xml中加入:

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

    <mvc:resources mapping="/swagger/**" location="/swagger/"/>

好了,到这里就大工告成了。
运行我们的项目
9b45780be701bcd704509a9543173ceb.png
在这里插入图片描述

要在SSM项目中集成Swagger,可以按照以下步骤进行操作: 1. 首先,确保你的项目中已经引入了Swagger的依赖。可以在你的项目的`pom.xml`文件中添加以下依赖: ```xml <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> ``` 2. 接下来,在Spring配置文件(一般是`applicationContext.xml`)中添加Swagger相关的配置。可以参考以下示例配置: ```xml <!-- 开启Swagger注解解析 --> <mvc:annotation-driven /> <!-- 配置Swagger资源访问路径 --> <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" /> <mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/" /> <!-- 配置Swagger扫描的包路径 --> <bean class="springfox.documentation.spring.web.plugins.Docket" id="defaultApi"> <constructor-arg> <bean class="springfox.documentation.builders.ApiInfoBuilder"> <constructor-arg> <value>API文档标题</value> </constructor-arg> <constructor-arg> <value>API文档描述</value> </constructor-arg> <!-- 可以根据需要添加其他信息,比如版本号、联系人等 --> </bean> </constructor-arg> <property name="selectors"> <bean class="springfox.documentation.builders.RequestHandlerSelectors" factory-method="basePackage"> <constructor-arg> <value>你的Controller所在的包路径</value> </constructor-arg> </bean> </property> </bean> ``` 3. 在你的Controller方法上添加Swagger相关的注解,来定义接口的信息和参数说明。可以使用`@ApiOperation`、`@ApiParam`、`@ApiResponses`等注解。例如: ```java @RestController @RequestMapping("/api") @Api(tags = "用户管理接口") public class UserController { @ApiOperation("获取用户列表") @GetMapping("/users") public List<User> getUsers() { // 方法逻辑 } @ApiOperation("新增用户") @PostMapping("/users") public void addUser(@ApiParam("用户信息") @RequestBody User user) { // 方法逻辑 } // 其他接口方法... } ``` 4. 启动项目,访问Swagger UI界面。在浏览器中访问`http://localhost:8080/swagger-ui.html`(具体端口号根据你的项目配置),即可看到生成的API文档和接口测试界面。 这样,你就成功地集成SwaggerSSM项目中,并可以通过Swagger UI来查看和测试API接口。希望对你有所帮助!如有问题,请随时提问。
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值