Springboot整合Swagger2

标签: java swagger
2人阅读 评论(0) 收藏 举报
分类:

1.新增jar包

   <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

2.新增@EnableSwagger2

@SpringBootApplication(scanBasePackages = {"org.java.com.*"})
@EnableSwagger2
public class Application {

    /**
     * 1.java -jar
     * <p>
     * 2.mvn spring-boot:run
     *
     * @param args
     */
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}
3.新增model类
@ApiModel("用户模型")
@AllArgsConstructor
@Data
public class User implements Serializable {
    private static final long serialVersionUID = -3378006049247087150L;

    @ApiModelProperty("用户编号")
    private Long id;
    @ApiModelProperty("用户姓名")
    private String name;
    @ApiModelProperty("登陆密码")
    private String password;

}

4.controller新增注解

@Api("user相关Api")
@RestController
@RequestMapping("/firstboot")
public class FirstBootController {

    @ApiOperation("根据id获取用户信息")
    @ApiImplicitParams({@ApiImplicitParam(paramType = "query", name = "id",
            dataType = "long", required = true, value = "用户编号id")})
    @ApiResponses({
            @ApiResponse(code = 0000, message = "调用成功", response = User.class)
    })
    @GetMapping(value = "/sayHello")
    public User getUserInfo(@RequestParam("id") Long id) {
        return new User(1L, "测试", "12334");
    }
}

5.浏览器输入

http://www.localhost.com:8080/swagger-ui.html

效果如下:

查看提供服务


查看模型


请求调用


查看评论

SpringBoot(七):SpringBoot整合Swagger2

相信各位在公司写API文档数量应该不少,当然如果你还处在自己一个人开发前后台的年代,当我没说,如今为了前后台更好的对接,还是为了以后交接方便,都有要求写API文档。 手写Api文档的几个痛点: ...
  • saytime
  • saytime
  • 2017-07-10 23:01:42
  • 17480

SpringBoot非官方教程 | 第十一篇:springboot集成swagger2,构建优雅的Restful API

swagger,中文“拽”的意思。它是一个功能强大的api框架,它的集成非常简单,不仅提供了在线文档的查阅,而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api,简单优雅...
  • forezp
  • forezp
  • 2017-04-30 16:13:56
  • 38710

SpringBoot+Mybatis+redis-cluster+Swagger2

  • 2017年12月26日 15:06
  • 156KB
  • 下载

SpringBoot Swagger2整合

Swagger简介 Swagger是一款Restful接口的文档在线自动生成+功能测试的软件。 Swagger是一个规范和完整的框架。用于生成、描述、调用和可视化Restful风格的Web服务。总体目...
  • weixin_39477597
  • weixin_39477597
  • 2018-03-21 15:41:51
  • 98

SpringCloud SpringBoot mybatis 分布式微服务(三十)springboot集成swagger2,构建优雅的Restfu API

swagger,中文“拽”的意思。它是一个功能强大的api框架,它的集成非常简单,不仅提供了在线文档的查阅,而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api,简单优雅...
  • AD11135
  • AD11135
  • 2018-03-07 10:45:46
  • 117

Spring Boot学习笔记 - 整合Swagger2自动生成RESTful API文档

在App后端开发中经常需要对移动客户端(Android、iOS)提供RESTful API接口,在后期版本快速迭代的过程中,修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,...
  • FX_SKY
  • FX_SKY
  • 2017-01-04 19:28:17
  • 7353

springboot整合swagger UI 、spring-data-JPA

本博客为个人所写,有不对地方请大家指正! 1.首先目录结构 2.pom.xml
  • lijunfan_rh
  • lijunfan_rh
  • 2017-01-17 10:41:14
  • 1243

Swagger(一) SpringBoot整合Swagger2简单的例子

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成...
  • u010919351
  • u010919351
  • 2017-04-11 19:12:57
  • 10367

Springboot整合swagger2项目的部署问题

转自:http://blog.sina.com.cn/s/blog_13b4eadda0102xaam.html 最近写了一个小项目,后端是springboot来搭建环境架构...
  • q944324153
  • q944324153
  • 2017-09-04 10:11:00
  • 644

Spring boot 1.5.9 结合 Swagger2 2.7.0 一步一个脚印

Spring boot 1.5.9 结合 Swagger2 2.7.0 一步一个脚印 pom.xml dependency> groupId>io.springfox...
  • gxk1992
  • gxk1992
  • 2017-12-11 16:55:20
  • 158
    个人资料
    持之以恒
    等级:
    访问量: 3465
    积分: 323
    排名: 24万+
    博客专栏
    文章存档