美文网首页
第六节:Spring Boot集成Swagger2

第六节:Spring Boot集成Swagger2

作者: Reg8888 | 来源:发表于2018-01-25 17:18 被阅读0次

构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTful API文档来记录所有接口细节,然而这样的做法有以下几个问题:
    1)由于接口众多,并且细节复杂(需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等),高质量地创建这份文档本身就是件非常吃力的事,下游的抱怨声不绝于耳。
    2)随着时间推移,不断修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,除非有严格的管理机制,不然很容易导致不一致现象。
Swagger2,它可以轻松的整合到Spring Boot中,并与Spring MVC程序配合组织出强大RESTful API文档,同时提供了强大的页面测试功能来调试每个RESTful API。
一:添加maven依赖

swagger2的相关jar依赖

二:在{ProjectName}Application.java同级创建Swagger2的配置类Swagger2

Spring boot ***Application.java同级目录 Swagger2的配置类示例

三:编写contoller层的API说明文档

@ApiOperation+@ApiImplicitParams(或@ApiImplicitParam)

四:访问Swagger UI页
    /{projectContextPath}/swagger-ui.html就可以访问

界面示例

相关文章

网友评论

      本文标题:第六节:Spring Boot集成Swagger2

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