博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
springboot 集成 swagger 自动生成API文档
阅读量:5278 次
发布时间:2019-06-14

本文共 1781 字,大约阅读时间需要 5 分钟。

Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案。

  • Swagger可以整合到代码中,在开发时通过注解,编写注释,自动生成API文档;
  • 方便前后端分离开发

swagger是什么?

API Developmentfor Everyone

springboot中集成swagger

1、添加pom依赖

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

2、添加swagger配置

@EnableSwagger2@RestController@SpringBootApplicationpublic class FamilyServerApplication {    public static void main(String[] args) {        SpringApplication.run(FamilyServerApplication.class, args);    }    @RequestMapping("/")    public String hello(){        return "hello billy!";    }}

3、在需要暴露的API上添加API注解

例如:

@Api("MemberManageController")@RestController@RequestMapping("member")public class MemberManageController extends BaseController {    @Autowired    private MembersManageService manageService;    /**     *  获取成员     * @return     */    @ApiOperation(value = "查询家庭成员", notes = "查询家庭成员")    @ApiImplicitParams(@ApiImplicitParam(name = "name", value = "姓名", paramType = "query", dataType = "String"))    @RequestMapping("getMembers")    public Object getMembers(String name){        logger.debug("开始。。。");        System.out.println(name);        Page
page = new Page<>(); IPage
membersByPage = manageService.getMembersByPage(page); Messager result = messager.successObjectResponse(membersByPage); return result; }}

4、启动项目,访问swagger-ui地址 

演示项目地址为: 

结果如下:

5、接口调试

返回结果:

 

 

备注:项目开发中,如果前后端分离,采用swagger特别方便。

转载于:https://www.cnblogs.com/BillyYoung/p/11024742.html

你可能感兴趣的文章
java中的占位符\t\n\r\f
查看>>
7.14
查看>>
IPython使用
查看>>
SDN2017 第一次作业
查看>>
MySQL通过frm 和 ibd 恢复数据过程
查看>>
AngularJs 学习笔记(2)
查看>>
关于元素优先级
查看>>
oo第一单元作业总结
查看>>
SRS源码——Listener
查看>>
web.xml 4.0 头
查看>>
一些有用的sql语句
查看>>
Java面向对象抽象类案例分析
查看>>
Python之路(第十八篇)shutil 模块、zipfile模块、configparser模块
查看>>
[LeetCode] Binary Tree Maximum Path Sum
查看>>
[Algorithms] Longest Increasing Subsequence
查看>>
Javascript实现页面左边的菜单选中项高亮显示
查看>>
mysql 常用命令
查看>>
IP追踪
查看>>
helios架构详解(二)客户端架构和cluster
查看>>
android--01系统体系结构
查看>>