Featured image of post 文档生成工具汇总

文档生成工具汇总

文档对于项目来说至关重要

API 文档生成工具

rap2

提供方便的接口文档管理、Mock、导出等功能

官网地址:rap2.taobao.org/

源码地址:后端 github.com/thx/rap2-de… / 前端 github.com/thx/rap2-do…

支持: 接口文档管理、Mock、导入导出、历史修改记录

eolinker

快速帮助企业构建 API 研发、测试、监控、安全、开放能力

官网地址:www.eolinker.com/#/

源码地址:github.com/airplayx/eo…

支持: API管理工具(快速生成、研发管理、自动化测试、微服务网关、监控)

swagger

借助Swagger开源和专业工具集,为用户,团队和企业简化API开发。

官网地址:swagger.io/

swagger编辑器:editor.swagger.io/#

源码地址:github.com/swagger-api…

支持: API管理工具(设计、开发、文档、测试、模拟、治理、监控)

YApi

旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API

官网地址:hellosean1025.github.io/yapi/

源码地址:github.com/ymfe/yapi

支持: 权限管理、可视化接口管理、Mock Server、自动化测试、数据导入、插件机制

apidoc

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

官网地址:apidocjs.com/

支持: 自动创建API文档

apigen

ApiGen是最简单,最易用且最现代的api doc生成器。专为PHP7.1而生。

源码地址:github.com/apigen/apig…

packagist地址:packagist.org/packages/ap…

支持: 自动创建API文档

showDoc

是一个非常适合IT团队的在线API文档、技术文档工具

官网地址:www.showdoc.com.cn/

源码地址:github.com/star7th/sho…

支持: API文档、数据字典、说明文档、团队协作、文档自动化、在线托管

MinDoc

是一款针对IT团队开发的简单好用的文档管理系统

官网地址:www.iminho.me/

源码地址:github.com/mindoc-org/…

支持: 文档管理、项目管理、权限管理、标签管理、导入导出

Gitlab的wiki

为指定仓库编写说明文档

官网地址:about.gitlab.com/

源码地址:github.com/gitlabhq/gi…

支持: 文档管理

对比

rap2能满足大多数API接口需求,支持json格式导入生成文档,且开源免费。提供线上和自行搭建环境。

eolinker堪称国内最强大的API接口管理工具,拥有完整的API生命周期管理解决方案。国内企业用的比较多,有基础版、专业版等多个产品方案。github已经不开源最新版本了。

swagger在全球范围使用最广的强大的API接口管理工具。

YApi完全开源免费,在内网搭建。简单、便捷、优雅的代名词。

apidocapigen都是需要编写代码时引入的,自动生成API文档的工具。

showDocMinDoc不仅仅用于API接口编写,还使用在技术文档的编写。

Gitlab的wiki主要为当前仓库代码编写说明文档,包括API文档、软件说明等,支持Markdown格式。

数据库 文档生成工具

什么是数据库文档? 其实在工作中进行项目交付的时候经常用到;简单来说数据库文档就是对整个数据库设计说明的文档,比如使用了哪个数据库,每张表的字段,类型说明等,然后整理成一个设计文档,这个文档多种多样,最常见的就是word,有了数据库文档对以后的数据库维护,或者进行二次开发都很方便;

screw

最近比较火的一款数据库文档生成工具目前支持如下几种数据库,其它还在开发中

  • MySQL
  • MariaDB
  • TIDB
  • Oracle
  • SqlServer
  • PostgreSQL
  • Cache DB

文档生成支持

文档生成支持

  • html
  • word
  • markdwon

使用方式 支持 java ,和 maven 插件, java方式看官方文档;

项目地址: gitee.com/leshalv/scr…

DBCHM

DBCHM 支持SqlServer/MySQL/Oracle/PostgreSQL/DB2/SQLite数据库。

支持的导出的文件格式;

  • chm
  • word
  • excel
  • pdf
  • html
  • xml
  • markdown

最新版本是 DBCHM.exe 软件,上手也容易;

项目地址:https://gitee.com/dotnetchina/DBCHM

TableGo

TableGo是基于数据库的代码自动生成工具,低代码编程技术的实现,可以零代码自动生成SpringBoot项目工程、生成JavaBean、生成MyBaits的Mapper映射配置文件、生成数据库设计文档(Word、Excel)、生成Swagger2离线API文档、生成前后端代码、能查出数据库数据生成各种代码和文档等;

支持MySQL、Oracle、SQL Server、PostgreSQL、MariaDB五种数据库;

使用自定义模板功能可以根据数据库表结构信息生成你想要的任何代码,例如:Java、C#、C++、Golang、Rust、Python、Objective-C、Swift、VB、VC、SQL、HTML、JSP、JS、PHP、Vue、React、Word、Excel等;

官网地址:www.tablego.cn/

Built with Hugo     主题 StackJimmy 设计