swagger-dubboDubbo 的 Swagger 服務(wù)文檔

swagger-dubbo支持dubbo以swagger方式展示文檔和rest風格的HTTP模擬測試，主要應用場景有以下幾點：

• 通過dubbo與swagger的集成，提供接口文檔的閱讀

• 開發(fā)人員可以用它來自測服務(wù)接口，也可以用它來模擬別人的服務(wù)接口返回值

• 測試可以用它來驗證接口的正確性，基于HTTP進行接口測試

swagger-dubbo從某些方面提高了內(nèi)部開發(fā)測試的效率，注意的是，rest服務(wù)不適合對外(前端)提供，務(wù)必在服務(wù)端或者測試內(nèi)部使用。

Maven

<dependency>
  <groupId>com.deepoove</groupId>
  <artifactId>swagger-dubbo</artifactId>
  <version>2.0.1</version>
</dependency>

兩步集成

一. 使用注解 @EnableDubboSwagger開啟dubbo的swagger文檔。

package com.deepoove.swagger.dubbo.example;

import org.springframework.context.annotation.Configuration;
import com.deepoove.swagger.dubbo.annotations.EnableDubboSwagger;

@Configuration
@EnableDubboSwagger
public class SwaggerDubboConfig {

}

二. 在spring的*-servlet.xml配置中，開啟屬性占位符的配置，開啟Configuration注解，聲明SwaggerDubboConfig。

<context:annotation-config />
<bean class="com.deepoove.swagger.dubbo.example.SwaggerDubboConfig" />
<context:property-placeholder />

集成已經(jīng)完畢，啟動web容器，瀏覽器訪問 http://ip:port/context/swagger-dubbo/api-docs查看文檔。

SpringBoot 集成 Swagger-dubbo

SpringBoot對配置做了簡化，集成swagger-dubbo只需要使用注解 @EnableDubboSwagger開啟dubbo的swagger文檔即可。