swagger-dubbo 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
swagger-dubbo 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
swagger-dubbo 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !

软件简介

swagger-dubbo支持dubbo以swagger方式展示文档和rest风格的HTTP模拟测试,主要应用场景有以下几点:

  • 通过dubbo与swagger的集成,提供接口文档的阅读

  • 开发人员可以用它来自测服务接口,也可以用它来模拟别人的服务接口返回值

  • 测试可以用它来验证接口的正确性,基于HTTP进行接口测试

swagger-dubbo从某些方面提高了内部开发测试的效率,注意的是,rest服务不适合对外(前端)提供,务必在服务端或者测试内部使用。

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 />

集成已经完毕,启动web容器,浏览器访问 http://ip:port/context/swagger-dubbo/api-docs查看文档。

SpringBoot 集成 Swagger-dubbo

SpringBoot对配置做了简化,集成swagger-dubbo只需要使用注解 @EnableDubboSwagger开启dubbo的swagger文档即可。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (4)

加载中
这端口是tcp端口还是http端口
2019/09/10 18:28
回复
举报
可以尝试尝试
2019/07/07 20:21
回复
举报
不错
2018/10/06 14:08
回复
举报
不错
2018/08/09 23:49
回复
举报
更多评论
暂无内容
发表了博客
2018/08/15 10:16

Swagger部署和dubbo集成之swagger注解

目标:通过swagger和dubbo集成在代码中添加注释自动在swagger ui中生成接口文档 常用注解: - @Api()用于类,表示标识这个类是swagger的资源 - @ApiOperation()用于方法,表示一个http请求的操作,在我们这边表示一个rpc请求 - @ApiParam()用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等) - @ApiModel()用于类,表示对类进行说明,用于参数用实体类接收 - @ApiModelProperty()用于方法,字段,表示对mod...

0
0
2019/06/25 11:32

swagger结合dubbo 2.7+

dubbo更新进度越来越快,swagger目前却原地不动,为了适应新版的dubbo,所以需要调整下swagger源码。 dubbo已加入Apache,所以包路径要调。 com.alibaba.dubbo 调整 org.apache.dubbo 找到 ReferenceManager类中getProxy(String interfaceClass);方法 源码中只有dubbo service的基本属性,所以实际运用中增加其它属性调试时就找不到了实现类了;这里尽量把所有的都加上去!!!...

0
0
2021/01/12 09:05

Dubbo 版 Swagger 来啦!Dubbo-Api-Docs 发布

作者 | 柯然(邪影) 背景 Swagger 是一个规范和完整的前端框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 规范也逐渐发展成为了 OpenAPI 规范。 Springfox 是一个集成了 Swagger,基于 Sring MVC/Spring Webflux 实现的一个 Swagger 描述文件生成框架,通过使用它定义的一些描述接口的注解自动生成 Swagger 的描述文件,使 Swagger 能够展示并调用接口。 相信很多人都听说和使用过 Swagger 和 Springfo...

0
0
2021/01/12 16:00

Dubbo 版 Swagger 来啦!Dubbo-Api-Docs 发布

![头图.png](https://ucc.alicdn.com/pic/developer-ecology/5b649e3f7fbc4889abdcdcf3320706ca.png) 作者 | 柯然(邪影) 来源|[阿里巴巴云原生公众号](https://mp.weixin.qq.com/s/Ug1tUcoY9jyBHI1jcqlbIw) # 背景 Swagger 是一个规范和完整的前端框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 规范也逐渐发展成为了 OpenAPI 规范。 Springfox 是一个集成了 Swagger,基于 Sring MVC/Spring Webflux...

0
0
发表了博客
2019/08/21 15:38

swagger部署和dubbo集成(二)restful swagger接入

1.引入swagger依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> 2.将下面的代码加入项目中 import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.RequestHandlerSel...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
4 评论
38 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部