【技术实现步骤摘要】
本专利技术涉及互联网应用，尤其是涉及一种接口文档的动态生成方法及终端。
技术介绍
1、目前各种系统基本上都是采用前后端分离的方式，来进行项目的开发以及联调。
2、为了能够快速支持前后端的联调工作，通常服务端人员都需要提供各种api接口的详细文档说明，服务端开发人员首先需要进行库表设计，在数据库中对应的不同字段需要添加字段的注释，用来表明哪些字段是什么含义的，同时，在编写接口代码之后，还需要在相关接口中的每一个字段都添加相对应的字段注释。而目前的接口文档生成方式，都是需要针对这些新增加的文档注释，才能自动生成接口文档，即同一个字段，开发人员需要优先在数据库字段中添加说明之后，再在接口字段中添加说明，是一种较为麻烦的方式；且需要添加两遍，同时，还可能遗漏或者两遍的注释内容不一致。
技术实现思路
1、本专利技术所要解决的技术问题是：提供一种接口文档的动态生成方法及终端，实现接口文档的动态生成，提高文档生成效率。
2、为了解决上述技术问题，本专利技术采用的技术方案为：
3、一种接口文档的动态生成方法，包括步骤：
4、s1、采用库表关联方式将每个接口返回的对象信息与数据库的库表进行一一映射；
5、s2、当进行接口文档自动生成时，先判断接口返回的对象信息是否与所述数据库表中的字段对应上，若是则直接使用该字段的注释说明，否则新增特殊标识进行注释补充；
6、s3、根据所述注释说明或所述注释补充动态生成接口文档。
7
8、一种接口文档的动态生成终端，包括存储器、处理器以及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现以下步骤：
9、s1、采用库表关联方式将每个接口返回的对象信息与数据库的库表进行一一映射；
10、s2、当进行接口文档自动生成时，先判断接口返回的对象信息是否与所述数据库表中的字段对应上，若是则直接使用该字段的注释说明，否则新增特殊标识进行注释补充；
11、s3、根据所述注释说明或所述注释补充动态生成接口文档。
12、本专利技术的有益效果在于：针对目前的自动化文档生成的注释的缺点，在旧有的基础功能之上，采用库表关联的方式，通过预先将接口中返回的对象信息与数据库的库表进行一一映射，在生成接口文档的过程中通过先判断接口返回的对象信息是否与所述数据库表中的字段对应上，若是则直接使用该字段的注释说明，否则通过新增特殊标识的方式进行注释补充，最后根据注释说明或注释补充来动态生成接口文档，从而开发人员只需要对于接口返回的对象信息的属性中字段未在数据库中的进行补充，即只需要在一处地方维护接口字段说明数据，实现接口文档的动态生成，提高文档生成效率。
本文档来自技高网...【技术保护点】
1.一种接口文档的动态生成方法，其特征在于，包括步骤：
2.根据权利要求1所述的一种接口文档的动态生成方法，其特征在于，所述步骤S1具体为：
3.根据权利要求2所述的一种接口文档的动态生成方法，其特征在于，所述步骤S2具体为：
4.根据权利要求3所述的一种接口文档的动态生成方法，其特征在于，所述步骤S21还包括：
5.根据权利要求3所述的一种接口文档的动态生成方法，其特征在于，所述步骤S3具体为：
6.一种接口文档的动态生成终端，其特征在于，包括存储器、处理器以及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现以下步骤：
7.根据权利要求6所述的一种接口文档的动态生成终端，其特征在于，所述步骤S1具体为：
8.根据权利要求7所述的一种接口文档的动态生成终端，其特征在于，所述步骤S2具体为：
9.根据权利要求8所述的一种接口文档的动态生成终端，其特征在于，所述步骤S21还包括：
10.根据权利要求8所述的一种接口文档的动态生成终端，其特征在于，
...【技术特征摘要】
1.一种接口文档的动态生成方法，其特征在于，包括步骤：
2.根据权利要求1所述的一种接口文档的动态生成方法，其特征在于，所述步骤s1具体为：
3.根据权利要求2所述的一种接口文档的动态生成方法，其特征在于，所述步骤s2具体为：
4.根据权利要求3所述的一种接口文档的动态生成方法，其特征在于，所述步骤s21还包括：
5.根据权利要求3所述的一种接口文档的动态生成方法，其特征在于，所述步骤s3具体为：
6.一种接口文档的动态生成终端，其特征在于，包...
【专利技术属性】
技术研发人员：刘德建，张少敏，郭孟祺，郑坦，郑锦斌，陈宏，
申请(专利权)人：福建天泉教育科技有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。