基于swagger-ui与eureka的文档中心

swagger是什么

Swagger™的目标是为REST APIs 定义一个标准的,与语言无关的接口,使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义,消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口,Swagger去掉了调用服务时的很多猜测。

spring集成swagger

网上有许多spring 集成swagger的文章,这里也就不多说了 ,放个链接
Setting Up Swagger 2 with a Spring REST API

项目简介

目前许多项目都是微服务架构,会有许多个独立的服务,如果仅仅只按照上面的教程集成swagger的话,文档会散落在个个服务之中,没有统一的一个视图去查看项目中集成了swagger的服务接口文档,所以就有了这个项目,一般目前的RESTful风格的微服务都是采用的spring cloud。所以这个项目的基础设施就是eureka,服务在eureka注册时会带上swagger的一些元数据,文档中心从eureka中获取集成了swagger的服务,统一显示接口文档

源码地址

api-docs-server