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

阿里巴巴云原生

私信 关注

326

原创>

0

翻译>

2

转载>

3

评论

32W+

人气

29

粉丝>

0

关注>

10

收藏

人生苦短, 开发用云 | 如何优雅完成程序员的侠客梦?

人生苦短, 开发用云 | 如何优雅完成程序员的侠客梦?

ArgoCD + KubeVela: 以开发者为中心的 GitOps

分布式全链路灰度发布的探索与实践

Serverless 在 SaaS 领域的最佳实践

热门文章

支持 gRPC 长链接, 深度解读 Nacos 2.0 架构设计及新模型

OpenKruise v0.7.0 版本发布: 新增周期任务分发控制器

年终盘点 | 七年零故障支撑 双 11 的消息中间件 RocketMQ, 怎么做到的?

dubbogo 3.0: 牵手 gRPC 走向云原生时代

距离 Java 开发者玩转 Serverless, 到底还有多远?

热评好文

从零开始入门 K8s | 理解 CNI 和 CNI 插件

高德最佳实践: Serverless 规模化落地有哪些价值?

你真的会学习吗? 从结构化思维说起

最新评论

你真的会学习吗? 从结构化思维说起

秦记: 写的挺好! 本人现在思考这个问题? 如何更快的学习! 如何将学习演练成技能!

高德最佳实践: Serverless 规模化落地有哪些价值?

wx5c515b0374ac3: 你好 ! 问一下课程 "云原生从技术基础到技术进阶系列专题" 有课件吗? 能提供一下吗? 谢谢!

从零开始入门 K8s | 理解 CNI 和 CNI 插件

wx59476a2a26030: 写的挺详细, 不错, 看来对 Docker 技术了解比较深入

目录

原创

<dependency>
  <groupId>
    org.apache.dubbo
  </groupId>
  <artifactId>
    dubbo-API-docs-annotations
  </artifactId>
  <version>
    ${dubbo-version}
  </version>
</dependency>
<dependency>
  <groupId>
    org.apache.dubbo
  </groupId>
  <artifactId>
    dubbo-API-docs-core
  </artifactId>
  <version>
    ${dubbo-version}
  </version>
</dependency>

<dependency>
  <groupId>
    org.apache.dubbo
  </groupId>
  <artifactId>
    dubbo-API-docs-annotations
  </artifactId>
  <version>
    2.7.8
  </version>
</dependency>

public class QuickStartRequestBean {
	@RequestParam(value = "You name", required = true, description = "please enter your full name", example = "Zhang San")
	private String name;
	@RequestParam(value = "You age", defaultValue = "18")
	private int age;
	@RequestParam("Are you a main?")
	private boolean man;
	// getter/setter 略...	
}

public class QuickStartRespBean {
	@ResponseProperty(value = "Response code", example = "500")
	private int code;
	@ResponseProperty("Response message")
	private String msg;
	// getter/setter 略...	
}

<dependency>
  <groupId>
    org.apache.dubbo
  </groupId>
  <artifactId>
    dubbo-API-docs-core
  </artifactId>
  <version>
    2.7.8
  </version>
</dependency>

@DubboService
@ApiModule(value = "quick start demo", apiInterface = IQuickStartDemo.class, version = "v0.1")
public class QuickStartDemoImpl implements IQuickStartDemo {
	@ApiDoc(value = "quick start demo", version = "v0.1", description = "this api is a quick start demo", responseClassDescription="A quick start response bean")
	@Override
	public QuickStartRespBean quickStart(@RequestParam(value = "strParam", required = true) String strParam, QuickStartRequestBean beanParam) {
	return new QuickStartRespBean(200, "hello" + beanParam.getName() + "," + beanParam.toString());	
}	
}

@Configuration
@Profile("dev") // 配合 Profile 一起使用, 在 profile 为 dev 时才会加载该配制类
@EnableDubboApiDocs // 开启 Dubbo-API-Docs
public class DubboDocConfig {
	
}

来源: http://blog.51cto.com/13778063/2588733