ssm集成swagger,分分钟快速上手swagger ,轻松生成文档,亲测可用

一、搭建好ssm框架
二、引入swagger的jar包,如果是web项目则需要把jar包放在lib下

<!--springfox的核心jar包-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!--springfox-ui的jar包(里面包含了swagger的界面静态文件)-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!--springfox依赖的jar包;如果你的项目中已经集成了无需重复-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.0</version>
        </dependency>

三、建立新包,加入一个类SwaggerConfig

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;

/*重要!如果你的项目引入junit测试,此处需要使用@WebAppConfiguration,如果没有使用junit使用@Configuration(很多的博客都没有注明这个问题,为此我花了非常多的时间解决问题)*/
@Configuration
@EnableSwagger2//重要!
@EnableWebMvc
@ComponentScan(basePackages = "com.dt.controller")//扫描control所在的package请修改为你control所在package
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("韩剧项目接口文档")
                .description("韩剧项目接口测试")
                .version("1.0.0")
                .termsOfServiceUrl("")
                .license("")
                .licenseUrl("")
                .build();
    }
}

四、加入注解注入

<bean class="com.dt.swagger.SwaggerConfig"/>
里面是类的地址,这里是我的路径,根据实际情况修改

五、导入swagger -ui 页面
下载地址https://swagger.io/tools/swagger-ui/download/
六、swagger-ui下载完成后,放在任意的位置,然后运行
这里写图片描述
七、修改上图中的index.html里面的参数
这里写图片描述
修改为:http://localhost:端口/v2/api_docs
八、启动项目,运行index.html即可查看到相应的接口
这里写图片描述
九、测试controller,添加详细的注解,页面的信息也会更加的详细

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@Controller
@RequestMapping(value = "/soa")
@Api(value="test1",description="测试接口描述")
public class TestController1 {
    /*
     * @ApiOperation(value = "接口说明", httpMethod ="接口请求方式", response ="接口返回参数类型", notes ="接口发布说明"
     *
     * @ApiParam(required = "是否必须参数", name ="参数名称", value ="参数具体描述"
     */
    @RequestMapping("test")
    @ApiOperation(value="接口说明(测试)",httpMethod="GET",notes="在没有会话、没有签名的情况下,进入方法体")
    public void test(HttpServletRequest request, HttpServletResponse response) {
        try {
            response.getWriter().write("ignoreAll");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
要在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接口。希望对你有所帮助!如有问题,请随时提问。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值