Swagger 自动生成 Dubbo 服务的接口文档,以及测试调用

Posted 芋道源码

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Swagger 自动生成 Dubbo 服务的接口文档,以及测试调用相关的知识,希望对你有一定的参考价值。

管她前浪,还是后浪?

能浪的浪,才是好浪!

每天 8:55 更新文章,每天掉亿点点头发...

源码精品专栏

 




  • 1. 概述
  • 2. Swagger Dubbo
  • 3. 接入 Knife4j 作为 Swagger UI 界面
  • 4. 接入 YApi 统一管理
  • 666. 彩蛋

1. 概述

在使用 SpringMVC 构建 HTTP API 时,我们可以通过 Swagger 自动生成 HTTP 接口文档,通过 Swagger UI 界面上进行 HTTP 接口调试。如下图所示:

Swagger 自动生成 Dubbo 服务的接口文档,以及测试调用
Swagger HTTP 界面

秃头提示:对 Swagger 不太了解的胖友,可以去阅读下艿艿写的 《芋道 Spring Boot API 接口文档 Swagger 入门》 文章。

开发体验杠杠的好!但是在使用 Dubbo 构建 RPC API 时,简直想要自闭。常常面临的痛苦是:

  • 隔壁团队的老王,不肯给 Dubbo 写 接口文档,只能从他的 Dubbo API 的 jar 包中寻寻觅觅想要的接口,贼不方便~
  • 自己编写的每个 Dubbo API 接口,都需要写个 Controller 或者 Test 类去调用测试, 接口调试非常麻烦~

在一个逐步自闭到要爆炸的下午,艿艿做了一波 Dubbo 接口文档与接口调试的调研,想要尝试这块的痛点。结果比想象中顺利且简单,这不趁着这无聊到抠脚的周末,整理下分享给胖友。

Swagger 自动生成 Dubbo 服务的接口文档,以及测试调用
IDEA 上号

以上是关于Swagger 自动生成 Dubbo 服务的接口文档,以及测试调用的主要内容,如果未能解决你的问题,请参考以下文章

接口文档自动更改?百度程序员开发效率MAX的秘诀

Spring Boot - 自动生成接口文档

接口文档生成工具Swagger2的使用

Swagger文档后端接口文档生成工具的使用

Gin 生成 Swagger 接口文档

Gin 生成 Swagger 接口文档