前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Spring+SpringMVC+Mybatis(开发必备技能)03、swagger(api接口开发必备,view视图略过)

Spring+SpringMVC+Mybatis(开发必备技能)03、swagger(api接口开发必备,view视图略过)

作者头像
红目香薰
发布2022-11-30 16:33:01
2180
发布2022-11-30 16:33:01
举报
文章被收录于专栏:CSDNToQQCodeCSDNToQQCode

Spring+SpringMVC+Mybatis(开发必备技能)

03、swagger(api接口开发必备,view视图略过)

目录

1、maven包·这里一定要用2.7.0,高版本对SSM兼容性忒差

2、swagger配置文件【com.item.swagger】

3、配置【webapp下【WEB-INF/swagger】】

4、spring-mvc.xml配置文件

5、控制器controller层


配套源码(初学者可下载有用):https://download.csdn.net/download/feng8403000/85483308

1、maven包·这里一定要用2.7.0,高版本对SSM兼容性忒差

代码语言:javascript
复制
    <!--swagger-->
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.7.0</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.7.0</version>
    </dependency>

2、swagger配置文件【com.item.swagger】

代码语言:javascript
复制
package com.item.swagger;

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;

@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("红目香薰")
                .select()
                //扫描指定包中的swagger注解
                .apis(RequestHandlerSelectors.basePackage("com.item.controller"))
                //扫描所有有注解的api,用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger API文档")
                .description("测试接口文档")
                .version("1.0")
                .build();
    }
}

3、配置【webapp下【WEB-INF/swagger】】

下载地址:https://download.csdn.net/download/feng8403000/85483175

解压位置:

4、spring-mvc.xml配置文件

代码语言:javascript
复制
<!--添加swagger配置-->
<bean class="com.item.swagger.SwaggerConfig"/>
<mvc:resources mapping="/swagger/**" location="/WEB-INF/swagger/"/>

5、控制器controller层

代码语言:javascript
复制
@Api("用户基本操作/接口|视图")
//返回api必须使用
@ResponseBody
@ApiOperation(value = "用作获取所有信息",notes = "查询所有",response = List.class)

测试控制器类:

代码语言:javascript
复制
package com.item.controller;

import com.item.model.Users;
import com.item.service.UsersService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

import java.util.List;
@Api(value = "用户接口")
@Controller
@CrossOrigin
@RequestMapping("/Users")
public class UsersController {
    @Autowired
    private UsersService usersService;

    @GetMapping("/GetInfoApi")
    @ResponseBody
    @ApiOperation(value = "查询所有",notes = "查询所有",httpMethod = "get")
    public Object GetInfoApi(){
        List<Users> list=usersService.GetInfo();
        System.out.println(list);
        return list;
    }
}

备注:这里如果使用的是【RequestMapping】则必须加上访问方式,否则出现全部访问方式。

代码语言:javascript
复制
@RequestMapping(value = "/GetInfoApi",method = RequestMethod.GET)

访问路径:【http://localhost:8080/swagger-ui.html

显示效果:

打开之后点击【Try it out!】 

 可以看到访问效果。

这个是api的,要加上【@ResponseBody注解】

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2022-06-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Spring+SpringMVC+Mybatis(开发必备技能)
  • 03、swagger(api接口开发必备,view视图略过)
  • 1、maven包·这里一定要用2.7.0,高版本对SSM兼容性忒差
  • 2、swagger配置文件【com.item.swagger】
  • 3、配置【webapp下【WEB-INF/swagger】】
  • 4、spring-mvc.xml配置文件
  • 5、控制器controller层
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档