一种自定义接口的实现方法与流程

本申请属于计算机软件，涉及接口开发，尤其涉及一种自定义接口的实现方法。

背景技术：

1、在传统的软件项目开发中，接口的开发重复又耗时，且不同的开发人员还会出现格式不统一等问题；传统的低码平台后端接口多是用固定的模板，或者配置复杂，对于一些组件的修改，需要系统开发人员修改后重新发布系统才行，且修改组件后容易对已经存在的一些接口产生影响。

技术实现思路

1、为了解决上述现有技术的不足，本申请提供一种自定义接口的实现方法，实现对在线调整或新增组件的支持，提高接口灵活性；并通过对历史模板的支持，解决重复配置的问题，提高效率。

2、为了实现上述目的，本发明采用以下技术：

3、一种自定义接口的实现方法，包括：

4、新建接口，录入当前接口主路由并添加对接口的描述；

5、录入时检验所录入的主路由地址是否已经被录入过而导致重复，若是，则修改主路由地址，直到修改为主路由地址不重复时继续进行下一步，若否，则直接进行下一步；

6、选择一个表作为当前接口的业务主表，以作为要操作的数据对象，以供后续步骤创建的操作项以此作为基础来生成业务代码；

7、设置至少一项本次需要创建的操作项；操作项包括新增、修改、删除、查询、导入、导出、上传、下载；一个主路由下包括若干操作项，一个操作项用于生成一个对应的业务接口；

8、根据所设置的操作项生成业务接口代码，其中，一个操作项对应一个业务接口，每个类型的操作项均对应有一个原始模板，业务接口根据原始模板生成业务接口代码，业务接口代码包括接口业务实现以及对应的接口文档；

9、对生成的业务接口代码进行编译并启动接口，接口启动成功后支持在线访问接口文档，并支持在线调用接口。

10、进一步，选择一个表作为当前接口的业务主表作为要操作的数据对象前，可选择历史已经创建的接口作为模块，在选择历史接口后，所选择的历史接口的所有配置被复制到当前接口中，从而后续操作只需要根据业务需求来选择性对配置进行调整，以快速实现新的接口。

11、进一步，选择好要操作的数据对象后，判断业务主表是否有关联多表，若有，则配置业务主表与其他表之间的关联关系以供后续操作及查询；若无，则进行下一步的设置操作项；其中，其他表是指在当前接口所属数据库中，除已选择过的业务主表外还需要进行新增、修改、删除、查询操作的其他表。

12、进一步，设置操作项后：

13、设置接口地址，为不同的操作项设置不同的请求方式以及接口的访问地址，各接口的访问地址为各接口的接口路由，接口路由为主路由下的子路由；

14、定义操作项属性，为不同的操作项设置不同的基础属性；

15、设置操作项入参，为不同的操作项设置不同的入参数据结构；

16、添加项关键字，根据当前接口的业务需求，为当前操作项添加不同的关键字，以便于后续接口业务代码根据当前操作项选择的关键字来生成；

17、设置操作项出参，根据各操作项内的变量为各操作项设置出参数据结构；

18、设置操作项出参后进行业务接口代码生成步骤。

19、进一步，基础属性包括新增操作项可以选择是否校验重复、是否级联新增，修改操作项可以选择全表修改也可以选择只修改部分字段，查询操作项可以选择是否分页、是否级联查询，删除操作项可以选择是否批量删除、是否级联删除。

20、进一步，操作项入参是指当前操作项对应接口的入参，入参的默认值根据操作项对应的业务表生成，并支持对入参进行新增和修改，设置入参后，后续该入参作为该业务接口内的变量提供给业务方法/关键字使用。

21、进一步，关键字可以添加到操作项执行前事件中和操作项执行后事件中；比如新增操作项，就可以在新增前事件和新增后事件中添加关键字；比如修改操作项，就可以在修改前事件和修改后事件中添加关键字；其他操作项也是如此。

22、进一步，关键字入参和出参，关键字的入参在选择关键字后设置入参的值，关键字入参的值为选择当前业务接口内的变量，或设置为固定值；设置关键字的入参的值后，该关键字对应的出参作为该业务内的新变量提供给当前业务接口以及位置在当前关键字后的其他关键字使用。

23、进一步，操作项出参是指当前操作项对应的接口的出参，出参的默认值根据操作项对应的业务表生成，并支持对出参进行新增和修改，出参的值设置为固定值或选择使用当前业务接口内的变量来组成。

24、本发明有益效果在于：

25、本发明的自定义接口实现方案，通过配置化创建接口，生成文档，减少了项目开发过程中的工作量，显著提高了接口开发效率和准确性；同时，通过在接口配置过程中支持添加关键字，提高了接口的灵活性，增加了适用范围；通过允许开发人员对生成的代码进行必要的修改，增加了可维护性；此外，本方案增加了模板的复用，支持在新建接口时选择使用历史接口作为模版，选择使用历史接口后，只需要根据业务需求进行一些调整，便可以快速实现新的接口，提高了使用上的便捷性。

技术特征：

1.一种自定义接口的实现方法，其特征在于，包括：

2.根据权利要求1所述的自定义接口的实现方法，其特征在于，选择一个表作为当前接口的业务主表作为要操作的数据对象前，可选择历史已经创建的接口作为模块，在选择历史接口后，所选择的历史接口的所有配置被复制到当前接口中。

3.根据权利要求1所述的自定义接口的实现方法，其特征在于，选择好要操作的数据对象后，判断业务主表是否有关联多表，若有，则配置业务主表与其他表之间的关联关系以供后续操作；若无，则进行下一步的设置操作项；其中，其他表是指在当前接口所属数据库中，除已选择过的业务主表外还需要进行新增、修改、删除、查询操作的其他表。

4.根据权利要求1所述的自定义接口的实现方法，其特征在于，设置操作项后：

5.根据权利要求4所述的自定义接口的实现方法，其特征在于，基础属性包括新增操作项可以选择是否校验重复、是否级联新增，修改操作项可以选择全表修改也可以选择只修改部分字段，查询操作项可以选择是否分页、是否级联查询，删除操作项可以选择是否批量删除、是否级联删除。

6.根据权利要求4所述的自定义接口的实现方法，其特征在于，操作项入参是指当前操作项对应接口的入参，入参的默认值根据操作项对应的业务表生成，并支持对入参进行新增和修改，设置入参后，后续该入参作为该业务接口内的变量提供给业务方法/关键字使用。

7.根据权利要求4所述的自定义接口的实现方法，其特征在于，关键字可添加到操作项执行前事件中和操作项执行后事件中。

8.根据权利要求4所述的自定义接口的实现方法，其特征在于，关键字包含入参和出参，关键字的入参在选择关键字后设置入参的值，关键字入参的值为选择当前业务接口内的变量，或设置为固定值；设置关键字的入参的值后，该关键字对应的出参作为该业务内的新变量，提供给当前业务接口以及位置在当前关键字后的其他关键字使用。

9.根据权利要求4所述的自定义接口的实现方法，其特征在于，操作项出参是指当前操作项对应的接口的出参，出参的默认值根据操作项对应的业务表生成，并支持对出参进行新增和修改，出参的值设置为固定值或选择使用当前业务接口内的变量来组成。

技术总结一种自定义接口的实现方法，包括：录入当前接口主路由并添加对接口的描述；录入时检验所录入的主路由地址是否重复，若是，修改到不重复时进行下一步，若否，直接进行下一步；选择一个表作为当前接口的业务主表；设置至少一项要创建的操作项；一个主路由下包括若干操作项；根据所设置的操作项生成业务接口代码，一个操作项对应一个业务接口，业务接口代码包括接口业务实现以及对应的接口文档；对生成的业务接口代码进行编译并启动接口，接口启动成功后支持在线访问接口文档，并支持在线调用接口。本方法实现对在线调整或新增组件的支持，提高接口灵活性；并通过对历史模板的支持，解决重复配置的问题，提高效率。技术研发人员：朱智源,冯黄鹰,邓思受保护的技术使用者：成都医星科技有限公司技术研发日：技术公布日：2024/9/26