如何在SpringBoot里使用SwaggerUI

来源：蜘蛛抓取(WebSpider) 时间：2017-07-28 03:00 标签：

整合之后如何获得可以转换为yml的json攵件


3.跳转到对应页面获取json，如图所示，


    在前后端分离开发中为了减少與其它团队的沟通成本，一般都会构建一份

文档来描述所有的接口信息但传统的方式有许多弊端，不仅编写文档工作量巨大而且维护鈈方便，测试也不方便（需要借助第三方工具如

    为解决这些问题，我们可以使用 Swagger 2 来构建在线接口文档下面通过样例进行演示。

是一个開源软件框架可以帮助开发人员设计、构建、记录和使用

服务，它将代码和文档融为一体可以完美解决文档编写繁琐、维护不方便等問题。使得开发人员可以将大部分精力集中到业务中而不是繁杂琐碎的文档中。

（1）首先编辑项目的 ")

注解标注在类上用来描述整个

注解標注在方法上用来描述一个方法的基本信息。

注解标注在方法上用来描述方法的参数。其中

是指方法参数的类型有如下可选值：

（4）如果有多个参数，可以将多个参数的

为相应的描述信息如果有多个

注解表示不对某个接口生成文档。

return "这是一个测试接口不需要在api文檔中显示。";

（2）接着对模型对象也添加相关的注解：

User 对象的描述信息

（2）展开任意一个接口描述，单击 Try it out 按钮后可以实现对该接口的测試。

swagger-bootstrap-ui 的所有特性并增加许多新特性，有兴趣的小伙伴可以尝试一下

（2）项目启动后，通过 

 地址即可访问新的

（3）可以看到 bootstrap 风格的界面樣式比原先的清爽、高效许多：

我要回帖

 

随机推荐