美文网首页
Spring Boot使用Swagger2构建restful A

Spring Boot使用Swagger2构建restful A

作者: 夏日橘子冰 | 来源:发表于2017-04-10 09:32 被阅读0次

    什么是swagger?

    Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步

    step1:添加swagger2的依赖

    step2:在Application.java同级创建Swagger2的配置类Swagger2

    如上代码所示,通过@Configuration注解,让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

    再通过createRestApi函数创建Docket的Bean之后,apiInfo()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,本例采用指定扫描的包路径来定义,Swagger会扫描该包下所有Controller定义的API,并产生文档内容(除了被@ApiIgnore指定的请求)。

    step3:添加文档内容,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明

    step4:启动项目,访问http://localhost:8080/swagger-ui.html即可看到如下:

    相关文章

      网友评论

          本文标题:Spring Boot使用Swagger2构建restful A

          本文链接:https://www.haomeiwen.com/subject/vhtsattx.html