程序文档工具swagger-dubbo、EasyDoc、RDoc-cli、yii2-doc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:swagger-dubbo(Dubbo 的 Swagger 服务文档)、EasyDoc(快速生成文档的工具)、RDoc-cli(基于 React 的文档生成工具)、yii2-doc(YII2 接口文档工具)。

1、swagger-dubbo(Dubbo 的 Swagger 服务文档)

程序文档工具swagger-dubbo、EasyDoc、RDoc-cli、yii2-doc介绍

重要说明:

swagger-dubbo起一个解析Swagger和收集文档的作用。

dubbo-swagger-doc是一个web应用,从注册中心获取所有文档,是一个dubbo接口的swagger文档。

dubbo-static-doc是一个dubbo接口的静态文档。

dubbo-apidoc是一个dubbo接口的javaAPI文档。

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文档即可。

下载地址:https://gitee.com/mirrors/swagger-dubbo

2、EasyDoc(快速生成文档的工具)

程序文档工具swagger-dubbo、EasyDoc、RDoc-cli、yii2-doc介绍

EasyDoc,简单、快速生成文档的工具。仅仅一个软件文件搞定!随带随用,不用安装,更不用其它依赖。支持微软、苹果、Linux等操作系统。EasyDoc 是使用 Go 语言开发的,是开源软件。

软件更新和下载

请从下面下载链接中下载(压缩包需要解压缩软件文件)。

仅一个软件文件,不安装,不依赖其他软件,支持Microsoft系统计算机,Apple系统计算机,Linux系统计算机。

如何更新软件:请下载新的软件文件,覆盖旧的软件文件。

EasyDoc是由Go语言开发的开源软件,可以使用源代码进行编译。 实际上,您不必这样做,我们已经编译和优化了可供下载的软件。

下载地址:https://gitee.com/wuyumin/easydoc

3、RDoc-cli(基于 React 的文档生成工具)

程序文档工具swagger-dubbo、EasyDoc、RDoc-cli、yii2-doc介绍

RDoc-cli主要用于快速生成文档工具或简单的网站,只需要写Markdown文件既可。

立即开始:

通过安装rdoc来快速开始,默认生成 rdoc 文档网站,基于这个简单工程创建自己的网站。

1].安装

npm install rdoc -g # 安装rdoc

2].初始化一个网站

rdoc init my-project

3].运行网站

$ cd my-project

$ npm start

4].编译输出HTML静态资源

npm run build

5].部署到 github 的 gh-pages 分支,需要关联 github 并设置 package.json 参数 push 到指定仓库的指定分支,默认推送到 gh-pages,指定分支需要跟上参数 -b master 即可。

以下在 package.json 中配置部署 URL:

{

"scripts": {

"deploy": "rdoc --publish  -b master"

...

},

...

}

然后部署到 Github gh-pages 分支:

npm run deploy

开发:

获取代码,进入目录,运行自动重载构建:

$ git clone https://github.com/jaywcjlove/rdoc.git

$ cd rdoc     # 进入目录

$ npm install # or yarn install

要开发,请运行自重载构建:

# 运行应用程序

# 每次代码更改时,自动重新启动应用程序。

# 在开发过程中很有用。

$ npm run start

打开浏览器并访问 http://localhost:5858。

下载地址:https://gitee.com/jaywcjlove/rdoc

4、yii2-doc(YII2 接口文档工具)

YII2接口文档工具:

使用注释自动生成基于YII2的接口文档,自动获取模型中注释。

安装方式:

composer require chatfeed/yii2-doc "*"

配置:

'module'=>[

'doc' => [

'class' => 'cfd\doc\Module',

'modelDescriptions'=>require __DIR__.'/model_description.php',

'modelsMap'=>[

'\common\base_models\kds\\',

]

]

]

用户自定义模型:

return [

'demo'=>[

['object','demo','模型'],

['integer','id','ID'],

['string','name','名称'],

['string','desc','描述'],

['integer','created_at','创建时间'],

['integer','updated_at','更新时间'],

]

];

下载地址:https://gitee.com/mirrors/yii2-doc

注明

以上就是程序文档工具swagger-dubbo、EasyDoc、RDoc-cli、yii2-doc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章