转载

基于 Spring Cloud 的 Microservices 架构实战案例：在线 API 管理

歪脖贰点零

关注程序员个人成长

simplemall项目前几篇回顾：

源码地址：https://github.com/backkoms/simplemall

前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架。本实战案例中也引入swagger2作为API管理工具，下面罗列下swagger2+SpringBoot使用步骤。

SpringBoot集成Swagger2

第一步，pom配置

第二步编写配置管理类Swagger2Config

经过以上两步简单的配置后，可以直接进行接口代码的编写。

使用swagger进行API管理的话，对代码有一定的侵入性，这个需要考虑在内。之前也提到过几种在线API的管理方式，点击链接《介绍几款常用的在线API管理工具》

使用SpringBoot技术，再以maven原始的方式引入swagger使用的话，远不如一个starter来的爽，这里介绍一个swagger-starter，可以更快捷的与spring boot集成使用。

在pom.xml中引入依赖：【当前最新版本 1.7.0.RELEASE】

注意：从1.6.0开始，我们按Spring Boot官方建议修改了artifactId为swagger-spring-boot-starter，1.6.0之前的版本不做修改，依然为使用spring-boot-starter-swagger !

在应用主类中增加@EnableSwagger2Doc注解

默认情况下就能产生所有当前Spring MVC加载的请求映射文档。

参数配置，配置示例

详细介绍可参考源码，地址：https://github.com/SpringForAll/spring-boot-starter-swagger。由于JDK代码编译版本的限制，JDK1.7是不支持的，可使用1.8

原文 https://mp.weixin.qq.com/s/bV1N8JyafH2jNSHI6-Tbuw

正文到此结束

所属分类： Java 编程技术

本文标签： git GitHub kk pom API http Spring cloud maven 管理 src springcloud 源码 UI 开发 springboot 编译配置参数 Spring Boot spring tar XML id 程序员 Service https 代码 FAQ
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。