程序文档工具Swagger UI、OB Configure、apidoc、XCFE介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Swagger UI(文档在线自动生成)、OB Configure(OceanBase配置管理中心)、apidoc(Web API 文档生成)、XCFE(XML 配置文件编辑器)。

1、Swagger UI(文档在线自动生成)

程序文档工具Swagger UI、OB Configure、apidoc、XCFE介绍

Swagger UI是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

2、OB Configure(OceanBase配置管理中心)

OB Configure是OceanBase配置管理中心,保存了所有的OceanBase Java客户端的配置参数,包括:数据库集群地址、用户名、密码以及数据源本身的配置项。其主要功能为:配置信息集中化管理和操作,简化DBA操作流程,同时方便OceanbBase Java客户端的升级。

搭建过程:

本项目为maven工程 + mysqldb,前提先配置好java/maven环境。

1].执行init_sql_20130517.sql文件的语句在mysql上建表。

2].修改obconfig-db.properties文件设置数据库连接属性。

3].执行mvn clean package -Dmaven.test.skip命令。

执行后为一个war包。

3、apidoc(Web API 文档生成)

程序文档工具Swagger UI、OB Configure、apidoc、XCFE介绍

生成一个REST风格的Web API文档。

apiDoc通过源代码中的API注释创建文档。

支持的编程语言:

C#、Go、Dart、Java、JavaScript、PHP(所有文件样式功能的语言)。

CoffeeScript。

Erlang。

Ruby。

安装:

npm install apidoc -g

运行:

apidoc -i myapp/ -o apidoc/ -t mytemplate/

创建目录myapp/中所有文件的apiDoc,使用目录mytemplate/中的模板,并将所有输出放入目录apidoc/。

如果没有任何参数,apiDoc将从当前目录(包括子目录)中的所有.cs、.dart、.erl、.go、.java、.js、.php、.py、.rb、.ts文件生成文档,并将输出写入./doc/。

下载地址:https://apidocjs.com/

4、XCFE(XML 配置文件编辑器)

程序文档工具Swagger UI、OB Configure、apidoc、XCFE介绍

XML Configuration File Editor (XCFE)-XML配置文件编辑器是用于更新XML配置文件的Web服务。它允许设置在CSV配置文件中定义的所有参数。

CSV配置文件由用分号分隔的5个字段组成。第一个字段名为“元素列表”,用于详细说明访问XML元素的路径,其中子字段之间用逗号分隔。第二个字段名为“参数”,用于定位XML属性,如果为空,则定位XML标记的内容。第三个字段名为“描述”,用于定义XCFE表单中的相应标签。名为“类型”的第四个字段用于设置“检查”,“浮动”,“ ip”,“ mac”或“字符串”中的值类型。最后一个字段名为“默认值”,用于定义每个输入提示中显示的默认值。

XCFE可以与极简主义的Webserveur WebConfig或Apache服务器及其PHP模块一起使用。

要求:

XFCE仅需要Apache/PHP的Web Config,它已经在Linux上使用WebConfig 1.2和Apache 2.2.14/PHP 5.3.2进行了测试,正在运行的DHCPD服务器是ISC DHCP服务器。

安装:

要安装,只需要:将归档文件解压缩到可访问的目录中,并确保配置目录对于Apache用户或Webconfig用户是可写的。

设置Apache:

要使用apache启用服务,需要在config.inc.php中配置变量CSVCONFIG、XMLCONFIG和CMDRESTART。CSVCONFIG用于定义XCFE的CSV配置文件,XMLCONFIG定义XML文件,CMDRESTART定义了重新启动守护程序命令。

设置webconfig:

要使用webconfig启用服务,需要在webconfig的别名配置文件中添加2行。第一行包含服务名称,存储XCFE文件的目录名称,XML文件的路径,描述名称和restart daemon命令。第二个包含服务名称,后跟/cfg,存储XCFE/cfg文件的目录名称以及XCFE的CSV配置文件。最后两个字段未使用,应将其留空。

下载地址:http://www.softndesign.org/codes/python/xcfe/

注明

以上就是程序文档工具Swagger UI、OB Configure、apidoc、XCFE的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章