【JAVA】通过IDEA和ApiPost生成接口文档

一个项目完成之后，客户都会要求交付接口文档，数据库设计文档等开发文档，并且把开发文档当作验收条件之一。

而我们程序员在开发的过程中，总会因为各种各样的原因没有写开发文档，有可能是项目工期紧张，有可能是个人习惯，也有可能没有形成文档意识。如果是小项目还好说，数据库表不多，业务逻辑不复杂，这种情况下可以安排人员在项目完成后再去书写开发文档，也费不了多大的精力和时间，但是如果是中大型项目，数据库动辄几百张表，接口动辄几百上千个，这样再去人工书写开发文档太费神了，所以我决定写这篇文章，来帮助一下和我一样正在因为写文档而深陷其中的程序员。数据库设计文档的生成我另写了篇文章，有兴趣的可以看一下，这里就只介绍接口文档的生成了。

目前我查阅了大量资料，发现网上给出很多生成接口文档的方法，有通过javadoc的，有通过swagger的，还有很多通过代码的方式去实现的，这些方法我都实验了一下，像以swagger为例的都是html，没办法转成word，直接打印网页吧，又和接口文档长得不一样。还有的像Apifox为例的没有办法导出word，导出的要不还是html，要不然是openapi.json格式，和我们预想的还是差了很多。

经过两天的实验，最终我确定了一个方法，可以导出word，而且也算是符合我心目中的接口文档，下面开始贴图上步骤。

一、准备工作

1、首先百度搜索Apipost，或者进入这个链接，这个是网页版的Apipost，这个网页版的是重点，导出文档也要从网页版这里导出，所以记好链接地址