栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

用Swagger-UI实现在线接口文档

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

用Swagger-UI实现在线接口文档

最近学习了一种简单的接口测试文档,这个接口文档既简单又方便前后端合作。
1:引入依赖


            io.springfox
            springfox-swagger2
            2.9.2
        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        

2,添加Swagger-UI的Java配置文件

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包下controller生成API文档
                .paths(PathSelectors.any())
                .build();
    }

    
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot整合Swagger2")
                .description("详细请咨询Q715661742")
                .version("1.0")
                .build();
    }
}

3,添加相应的注释

import com.smxy.entity.VipLevel;
import com.smxy.service.AdminService;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;



@RestController
@RequestMapping("/admin")
@CrossOrigin
public class AdminController {

    @Autowired
    AdminService adminService;

    @PostMapping("/getVipLevel")
    @ApiOperation("查找所有的vip会员")
    public List  getVipLevel() {
        List vipLevel = adminService.getVipLevel();
        return vipLevel;
    }

    @PostMapping("/updateVipLevel")
    @ApiOperation("修改会员的内容以及属性")
    public Boolean updateVipLevel(@RequestBody VipLevel vipLevel){
        return adminService.updateVipLevel(vipLevel) > 0;
    }

}

4,效果展示

注:我用的是8082端口
可参考的地址:https://blog.csdn.net/qq_37330730/article/details/105166890
https://blog.csdn.net/zhanggonglalala/article/details/98070986

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/306756.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号