介绍

wrdoclet(问道)是Github上的开源项目,目的是自动化生成服务的接口文档。

indexPage

生成的接口文档主要分为四个区域。最上方是搜索区域,方便使用人员快速查询到需要使用的接口。左侧是标签区域以及接口列表区域。点击标签后,接口列表区域就会展示打上该标签的所有接口。中央是接口详情区域,对接口的入参、出参以及修改历史等进行详细的说明。

生成的接口文档示例请参见:

demo wrdoclet

或者

demo Spring MVC site API DOC

demo SOAP service API DOC

demo dubbo service API DOC


wrdoclet(问道)主要有两种使用模式。

一种是本地模式,比较适用于单一系统,且接口较少的情况。文档生成后直接发送给需要阅读的接口使用方即可。本地模式下暂不支持搜索。

另外一种是云端模式,是推荐使用的模式,更适用于多人、多团队合作。生成的接口文档分系统、代码分支推送到云端。引入代码分支的原因是,在快速迭代的项目中,有时会有多个分支同时在进行开发,接口使用方需要分别查阅不同迭代下的文档。 云端模式下查阅接口文档只需要通过浏览器打开服务器首页即可看到最新的接口文档。云端模式需要部署服务器,具体可参见“服务端部署”章节。

results matching ""

    No results matching ""