A doc tool can assist you to develop libraries & write docs.
dumi 安装:
$ pnpm install $ npm run dev $ npm run build
官网介绍:A magical documentation site generator.. 这个需要 Node,然后安装 docsify-cli。
npm i docsify-cli -g docsify init ./docs ...
db-doc 是一款生成在线数据库文档的小工具,支持 MySQL 和 SQL Server,使用起来也很简单,下载 Windows 版或 Linux 版打开, 按照提示输入配置即可:
? Database type: 1:MySQL 2:SQL Server 1 ? Database host (127.0.0.1) : 127.0.0.1 ? Database port (3306) : 3306 ? Database username (root) : root ? Database password (123456) : 123456 ? Database name: test Doc generate successfully! Doc server is running : http://127.0.0.1:3000
浏览器访问: http://127.0.0.1:3000
传送门:https://github.com/viodo/db-doc
MuleSoft 的 API 控制台工具,是一个成熟的 API 文档工具,可基于 RAML(Restful API 建模语言)或 OAS(Open API 规范)文档生成适合移动设备的 Web 文档。 除了提供文档外,该工具还为用户提供了即时尝试请求的功能:
传送门:MuleSoft API Console - Github
这里推荐一个国内的在线 API 文档生成管理工具,简单好用的在线接口文档管理工具,包含接口测试工具,有点像 Postman,还可以分享,如下:
apidoc 是通过源码中的注释来生成 Web API 文档。因此,apidoc 对现有代码可以做到无侵入性。此外,apidoc 可以支持多种语言 C#, Go, Dart, Java, JavaScript, PHP, TypeScript (all DocStyle capable languages),CoffeeScript,Erlang,Perl,Python,Ruby,Lua。通过 apidoc 可以非常方便地生成可交互地文档页面。
需要 node.js 的支持。在搭建好 node.js 环境后,通过终端输入 npm 命名进行安装。
npm install apidoc -g
接着,需要添加 apidoc.json
文件到项目工程的根目录下。
{ "name": "example", "version": "0.1.0", "description": "apiDoc basic example", "title": "Custom apiDoc browser title", "url" : "https://api.github.com/v1" }
这里,主要演示 Java 注释如何和 apidoc 结合使用。现在,我们先来看一个案例。
/** * @api {GET} logistics/policys 查询签收预警策略 * @apiDescription 查询签收预警策略 * @apiGroup QUERY * @apiName logistics/policys * @apiParam {Integer} edition 平台类型 * @apiParam {String} tenantCode 商家名称 * @apiPermission LOGISTICS_POCILY */
最后,在终端输入 apidoc 命令进行文档生成。这里,我们用自己的项目工程的根目录替代 myapp/,用需要生成文档的地址替代 apidoc/。
apidoc -i myapp/ -o apidoc/ #例如配置 apidoc -i /Users/lianggzone/Documents/dev-space/git-repo -o /Users/lianggzone/Documents/dev-space/apidoc/