【懒程序员的日常】接口文档绝对是个混账！

在多人团队前后端配合协作作业中，一份良好的接口稳定可以使前端以及后端开发人员通畅地进行并行研发。在需求制定后，后端人员投入编码工作前，需要做好接口设计，并整理成接口文档，以便前端人员开展后续工作。

然而在实际的作业当中，由于需求的不确定性以及研发工作的任务变更等不确定因素，之前制定好的接口文档往往无法实时地与实际的代码同步，从而导致了前端人员与后端人员的工作脱轨。诚然，编写接口文档，既能保证前端工作人员作业的顺利进行，又能让后端人员编写代码前整理接口开发的思路，而且也十分有利于后期的维护工作，但是由于接口文档不能同步，从而让文档成为一纸空文，这不得不说是让人头疼的一件事情。

实际上，类似的解决方案已经有了，如Java-Doc等插件工具，也有着很不错的效果。但是由于无法满足我本人的实际需求，所以在此并没有去采用。

本人对这个插件有以下这几个要求：
1.该工具应该能根据代码自动生成文档；
2.该工具应该尽可能少地对原工程植入不必要的其他代码。
3.该工具除了提供对应的接口文档，应该能针对前端的开发工作提供一套合适的中间数据层，即生成假数据，让前端在后端人员开发工作完成前能够顺利调用接口，一旦后端人员开发完成后，能够无缝切换模式到真正的业务逻辑层。

本插件仅适合我个人的编码风格，无法提供给其他人进行使用。

插件的使用方法：
在Controller层配置如下，制定name，url，request，response以及desc即可

在对应的request以及response中在参数右边写上注释，第一部分是参数描述，用;隔开，第二部分是是否为必要参数：

产生的效果：

由于该插件无法提供给他人使用，所以不开放源码。如果有其他建议，可以一起交流。