API的处理方法及装置、电子设备与流程

api的处理方法及装置、电子设备
技术领域
1.本技术涉及计算机领域，具体涉及一种api的处理方法及装置、电子设备。


背景技术：

2.随着科技的不断创新，互联网行业也在高速发展，网关在复杂的网络互联中起到至关重要的作用，它可以实现不同网络的互联，以及不同协议之间的转换。在此期间涌现出多种优秀的网关，其中，有着良好性能的应用程序接口(application programming interface，api)网关备受关注，例如soul网关。但api网关仅在api路由方面有了前端交互，对于api的详细信息没有提供，导致应用方面api信息展示不完善。


技术实现要素：

3.本技术实施例的目的在于提供一种api的处理方法及装置、电子设备，以解决现有技术中api网关仅在api路由方面有前端交互，导致应用方面api信息展示不完善的问题。具体技术方案如下：
4.在本技术实施的第一方面，提供了一种应用程序接口api的处理方法，包括：在目标页面创建api表单；在所述api表单中添加所述api属性信息，得到api列表；基于所述api列表对以下至少一项进行处理：所述api属性信息、所述api列表。
5.在本技术实施的第二方面，提供了一种应用程序接口api的处理装置，包括：创建模块，用于在目标页面创建api表单；添加模块，用于在所述api表单中添加所述api属性信息，得到api列表；处理模块，用于基于所述api列表对以下至少一项进行处理：所述api属性信息、所述api列表。
6.在本技术实施的第三方面，提供了一种电子设备，包括处理器、通信接口、存储器和通信总线，其中，处理器，通信接口，存储器通过通信总线完成相互间的通信；存储器，用于存放计算机程序；处理器，用于执行存储器上所存放的程序时，实现第一方面所述的方法步骤
7.在本技术实施的第四方面，提供了一种计算机可读存储介质，所述计算机可读存储介质中存储有指令，当其在计算机上运行时，使得计算机执行第一方面所述的方法。
8.本技术可以应用于知识图谱技术领域用于对api网关进行优化。本技术提供的上述技术方案与现有技术相比具有如下有点：在本技术中，可以在目标页面创建的api表单上添加api属性信息，得到api列表，进而可以基于该api列表对api属性信息和/或api列表进行处理，也就是说，可以在前端页面对api属性信息和/或api列表进行处理，从而可以丰富与该api关联的网关的配置，以及可以基于对api属性信息和/或api列表进行处理，可以进一步完善业务应用，解决了现有技术中api网关仅在api路由方面有前端交互，导致应用方面api信息展示不完善的问题。
附图说明
9.图1是本技术实施例中的api的处理方法的流程图；
10.图2是本技术实施例中的api的处理装置的结构示意图；
11.图3是本技术实施例中的电子设备的结构示意图。
具体实施方式
12.下面将结合本技术实施例中的附图，对本技术实施例中的技术方案进行清楚地描述，显然，所描述的实施例是本技术一部分实施例，而不是全部的实施例。基于本技术中的实施例，本领域普通技术人员获得的所有其他实施例，都属于本技术保护的范围。
13.本技术的说明书和权利要求书中的术语“第一”、“第二”等是用于区别类似的对象，而不用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便本技术的实施例能够以除了在这里图示或描述的那些以外的顺序实施，且“第一”、“第二”等所区分的对象通常为一类，并不限定对象的个数，例如第一对象可以是一个，也可以是多个。此外，说明书以及权利要求中“和/或”表示所连接对象的至少其中之一，字符“/”，一般表示前后关联对象是一种“或”的关系。
14.下面将结合本技术实施例中的附图，对本技术实施例中的技术方案进行描述。
15.如图1所示，在本技术实施例中提供了一种api的处理方法，该方法的步骤包括：
16.步骤102，在目标页面创建api表单；
17.步骤104，在api表单中添加api属性信息，得到api列表；
18.步骤106，基于api列表对以下至少一项进行处理：api属性信息、api列表。
19.通过上述步骤102至步骤106，可以在目标页面创建的api表单上添加api属性信息，得到api列表，进而可以基于该api列表对api属性信息和/或api列表进行处理，也就是说，可以在前端页面对api属性信息和/或api列表进行处理，从而可以丰富与该api关联的网关的配置，以及可以基于对api属性信息和/或api列表进行处理，可以进一步完善业务应用，解决了现有技术中api网关仅在api路由方面有前端交互，导致应用方面api信息展示不完善的问题。
20.在本技术实施例的可选实施方式中，本技术实施例中的api可以应用于soul网关，当然，在其他应用场景中该aip也可以应用于其他api网关。
21.在本技术实施例的可选实施方式中，在步骤102涉及到的目标页面创建api表单之前，本技术实施例的方法还可以包括：
22.步骤100，定义api属性信息；
23.其中，api属性信息包括以下至少一项：服务信息、api名称、用于表征请求类型的http方法、用于表征api中参数信息的后端参数、用于配置路由信息的网关分组、用于配置api访问路径的请求路径、用于表征返回数据类型的返回类型、用于标识错误信息的错误码。
24.可见，在本技术实施例中可以在目标页面创建的api表单中添加上述具体的api属性信息，当然，上述属性信息仅仅是举例说明，只要是与api相关的属性信息均是可以实际情况，在上述api属性的基础上进行增加或删减。
25.在本技术的示例中，服务信息可以包括服务类别、服务名称等与服务相关的信息，
例如，服务类别可以人力资源，对应的服务名称可以是考勤、请假记录等等；如果服务类别为财务，则对应的服务名称可以是薪资、报销费用等。需要说明的是，上述具体服务信息所包括的内容可以根据实际情况进行设置，例如还可以增加服务详情等。
26.在本技术的示例中，api名称是预先设置的，可以根据具体api所对应的服务进行预命名，或者可以基于其他方式进行预命名。
27.在本技术的示例中，用于表征请求类型的http方法可以包括：get，post,put,deleted。
28.在本技术示例中，用于配置api访问路径的请求路径可以包括：ip地址、端口号、前缀、path(路径)，例如：ip地址：172.21.1.111:9195；端口号：9195；前缀：aatest；path：/aaa/bbb(即前端的地址，即对外暴露的地址)。
29.在本技术的示例中，用于表征api中参数信息的后端参数是指实际后端服务地址，即实际的接口地址。例如，上述请求路径中所请求的172.21.1.111:9195/aatest/aaa/bbb映射到172.21.1.223:12345/a/b/c；则访问的是172.21.1.111:9195/aatest/aaa/bbb；而实际调用的地址是这个172.21.1.223:12345/a/b/c；且前端请求路径是对外暴露的172.21.1.111:9195/aatest/aaa/bbb；后端请求路径不对外包露172.21.1.223:12345/a/b/c。又例如，请求路径中所请求的172.21.1.222:7564/aatest/ccc/ddd映射到172.21.1.333:12345/e/f/g；则访问的是172.21.1.222:7564/aatest/ccc/ddd；而实际调用的地址是这个172.21.1.333:12345/e/f/g；且前端请求路径是对外暴露的172.21.1.222:7564/aatest/ccc/ddd；后端请求路径不对外包露172.21.1.333:12345/e/f/g。
30.在本技术的示例中，用于标识错误信息的错误码是指错误信息状态的状态码。
31.基于上述本技术实施例中api属性信息，在本技术实施例的步骤104中涉及到的在api表单中填写api属性信息，可以根据需求对api属性进行灵活配置，例如，可以灵活配置请求的访问路径和后端参数(即前端和后端)，也可以通过服务信息将相应的服务与api绑定。因此，通过本技术，在定义api属性信息之后，可以在目标页面上全面且直观的进行属性信息的填写，不仅可以将api的详细信息与aip网关关联，而且通过前端页面的方式，可以更加方便快捷的对其进行配置。
32.在本技术实施例的可选实施方式中，在本技术实施例中步骤106中涉及到的基于api列表对api属性信息进行处理的方式，进一步包括以下至少一项的方式：
33.方式1：在目标页面展开显示api属性信息；
34.需要说明的是，在上述api列表中，如果api属性信息较多可以长页面显示，或者是隐藏式显示等显示方式。其中，长页面显示是指由于属性信息较多，在当前页面只能显示部分属性页面，可以通过下拉的方式显示其他属性信息，例如，在当前页面只能显示属性信息1至属性信息6，剩下的属性信息7至属性信息10未在当前页面显示，因此，可以通过下来的方式来显示属性信息5至属性信息10，从而可以显示属性信息7至属性信息10。而对于隐藏式显示是指，如果当前页面可以显示属性信息1至属性信息6，但其中属性信息5和属性信息6是预设的，无需用户填写，以及无权修改，则可以在当前页面中无需显示属性5和属性信息6，则可以通过隐藏属性信息5至属性信息6，而只显示属性信息1至属性信息4。
35.而在本技术中可以在目标页面展开显示该api属性信息，从而可以全面展示api属
性信息。
36.方式2：在api列表未上线的情况下，对api属性信息中的第一属性信息进行修改；其中，api属性信息还包括第二属性信息；第二属性信息为禁止修改的属性信息；
37.需要说明的是，本技术实施例中的未上线是指api列表未被使用。此外，该第一属性信息可以包括：api名称、错误码、返回类型等属性信息中关于描述类的信息。可见，在本技术中可以有针对性的对能够修改的属性信息进行修改，而且还能避免对其他不能修改的属性信息进行修改，在满足属性信息可调整性的情况下，确保了api表单的可使用性。
38.在本技术实施例的另一个可选实施方式中，对于本技术步骤106中涉及到的基于api列表对api列表进行处理的方式，进一步可以包括以下至少一项：
39.方式1：在api列表未上线的情况下，删除api列表；
40.可见，在本技术实施例中，如果配置有多个api列表，部分api列表可以使用完之后，可能在较长一段时间内无需使用，或只需要使用一次即可，则可以将满足这些需求的api列表删除，以节省资源。例如，当前api列表的作用是查看公司中工资最高的员工，但是老板发现工资应该保密，就不打算用这个api列表，不允许将这个api列表上线，因此，该api列表在未上线的情况下，可以对其进行删除，以节省资源。
41.方式2：通过设置的一个或多个查询条件，在目标页面查询与一个或多个查询条件对应的api列表。
42.在本技术实施例中，在设置有多个api列表的情况下，可以通过设置的一个或多个查询条件以快速查询对应的api列表，查询方式支持关键词的模糊查询，也可以是支持基于属性信息的精准查询。例如，模糊查询可以设置一个或多个关键词进行查询，其中可以进一步设置该关键词是或的关系，也可以是和的关系，又或者是和/或的关系，如需要查询的关键词为a、b、c,则具体可以是a或b或c，又或者是a和b和c，又或者可以是(a和b)或c等不同的方式进行查询。精准查询则是设置多个条件，且多个条件都需要满足，则表明查询同时满足该多个条件的查询结果。
43.通过本技术中api的处理方法，可以定义api属性信息，还可以在目标页面添加api属性信息，进而对api列表或api属性信息进行处理，满足了soul网关同步要求的基本信息，并将api信息页面化，通过api详情能全面的获得api相关的全部属性信息，以及通过多条件限定查询加快了api查找的速率，使得用户操作更加简单快捷。
44.如图2所示，本技术实施例还提供了一种应用程序接口api的处理装置，包括：
45.创建模块22，用于在目标页面创建api表单；
46.添加模块24，用于在api表单中添加api属性信息，得到api列表；
47.处理模块26，用于基于api列表对以下至少一项进行处理：api属性信息、api列表。
48.通过本技术中的api的处理装置，可以在目标页面创建的api表单上添加api属性信息，得到api列表，进而可以基于该api列表对api属性信息和/或api列表进行处理，也就是说，可以在前端页面对api属性信息和/或api列表进行处理，从而可以丰富与该api关联的网关的配置，以及可以基于对api属性信息和/或api列表进行处理，可以进一步完善业务应用，解决了现有技术中api网关仅在api路由方面有了前端交互，导致应用方面不完善的问题。
49.可选地，本技术实施例的装置还可以包括：定义模块，用于在目标页面创建api表
单之前，定义api属性信息；
50.其中，api属性信息包括以下至少一项：服务信息、api名称、用于表征请求类型的http方法、用于表征api中参数信息的后端参数、用于配置路由信息的网关分组、用于配置api访问路径的请求路径、用于表征返回数据类型的返回类型、用于标识错误信息的错误码。
51.可见，在本技术实施例中可以在目标页面创建的api表单中添加上述具体的api属性信息，当然，上述属性信息仅仅是举例说明，只要是与api相关的属性信息均是可以实际情况，在上述api属性的基础上进行增加或删减。
52.在本技术的示例中，服务信息可以包括服务类别、服务名称等与服务相关的信息，例如，服务类别可以人力资源，对应的服务名称可以是考勤、请假记录等等；如果服务类别为财务，则对应的服务名称可以是薪资、报销费用等。需要说明的是，上述具体服务信息所包括的内容可以根据实际情况进行设置，例如还可以增加服务详情等。
53.在本技术的示例中，api名称是预先设置的，可以根据具体api所对应的服务进行预命名，或者可以基于其他方式进行预命名。
54.在本技术的示例中，用于表征请求类型的http方法可以包括：get，post,put,deleted。
55.在本技术示例中，用于配置api访问路径的请求路径可以包括：ip地址、端口号、前缀、path(路径)，例如：ip地址：172.21.1.111:9195；端口号：9195；前缀：aatest；path：/aaa/bbb(即前端的地址，即对外暴露的地址)。
56.在本技术的示例中，用于表征api中参数信息的后端参数是指实际后端服务地址，即实际的接口地址。例如，上述请求路径中所请求的172.21.1.111:9195/aatest/aaa/bbb映射到172.21.1.223:12345/a/b/c；则访问得是172.21.1.111:9195/aatest/aaa/bbb；而实际调用的地址是这个172.21.1.223:12345/a/b/c；且前端请求路径是对外暴露得172.21.1.111:9195/aatest/aaa/bbb；后端请求路径不对外包露172.21.1.223:12345/a/b/c。又例如，请求路径中所请求的172.21.1.222:7564/aatest/ccc/ddd映射到172.21.1.333:12345/e/f/g；则访问的是172.21.1.222:7564/aatest/ccc/ddd；而实际调用的地址是这个172.21.1.333:12345/e/f/g；且前端请求路径是对外暴露的172.21.1.222:7564/aatest/ccc/ddd；后端请求路径不对外包露172.21.1.333:12345/e/f/g。
57.在本技术的示例中，用于标识错误信息的错误码是指错误信息状态的状态码。
58.基于上述本技术实施例中api属性信息，在本技术实施例中的添加模块可以根据需求对api属性进行灵活配置，例如，可以灵活配置请求的访问路径和后端参数(即前端和后端)，也可以通过服务信息将相应的服务与api绑定。因此，通过本技术，在定义api属性信息之后，可以在目标页面上全面且直观的进行属性信息的填写，不仅可以将api的详细信息与aip网关关联，而且通过前端页面的方式，可以更加方便快捷的对其进行配置。
59.可选地，本技术实施例中的处理模块26进一步可以包括以下至少一项：
60.1)显示单元，用于在目标页面展开显示api属性信息；
61.需要说明的是，在上述api列表中，如果api属性信息较多可以多界面显示，或者是隐藏式显示等显示方式。而在本技术中可以在目标页面展开显示该api属性信息，从而可以
全面展示api属性信息。其中，长页面显示是指由于属性信息较多，在当前页面只能显示部分属性页面，可以通过下拉的方式显示其他属性信息，例如，在当前页面只能显示属性信息1至属性信息6，剩下的属性信息7至属性信息10未在当前页面显示，因此，可以通过下来的方式来显示属性信息5至属性信息10，从而可以显示属性信息7至属性信息10。而对于隐藏式显示是指，如果当前页面可以显示属性信息1至属性信息6，但其中属性信息5和属性信息6是预设的，无需用户填写，以及无权修改，则可以在当前页面中无需显示属性5和属性信息6，则可以通过隐藏属性信息5至属性信息6，而只显示属性信息1至属性信息4。
62.2)修改单元，用于在api列表未上线的情况下，对api属性信息中的第一属性信息进行修改；其中，api属性信息还包括第二属性信息；第二属性信息为禁止修改的属性信息。
63.需要说明的是，本技术实施例中的未上线是指api列表未被使用。此外，该第一属性信息可以包括：api名称、错误码、返回类型等属性信息中关于描述类的信息。可见，在本技术中可以有针对性的对能够修改的属性信息进行修改，而且还能避免对其他不能修改的属性信息进行修改，在满足属性信息可调整性的情况下，确保了api表单的可使用性。
64.可选地，本技术实施例的处理模块26进一步可以包括以下至少一项：
65.删除单元，用于在api列表未上线的情况下，删除api列表；
66.可见，在本技术实施例中，如果配置有多个api列表，部分api列表可以使用完之后，可能在较长一段时间内无需使用，或只需要使用一次即可，则可以将满足这些需求的api列表删除，以节省资源。例如，当前api列表的作用是查看公司中工资最高的员工，但是老板发现工资应该保密，就不打算用这个api列表，不允许将这个api列表上线，因此，该api列表在未上线的情况下，则在未上线的情况下，可以对其进行删除，以节省资源。
67.查询单元，用于通过设置的一个或多个查询条件，在目标页面查询与一个或多个查询条件对应的api列表。
68.在本技术实施例中，在设置有多个api列表的情况下，可以通过设置的一个或多个查询条件以快速查询对应的api列表，查询方式支持关键词的模糊查询，也可以是支持基于属性信息的精准查询。例如，模糊查询可以设置一个或多个关键词进行查询，其中可以进一步设置该关键词是或的关系，也可以是和的关系，又或者是和/或的关系，如需要查询的关键词为a、b、c,则具体可以是a或b或c，又或者是a和b和c，又或者可以是(a和b)或c等不同的方式进行查询。精准查询则是设置多个条件，且多个条件都需要满足，则表明查询同时满足该多个条件的查询结果。
69.通过本技术中api的处理装置，可以定义api属性信息，还可以在目标页面添加api属性信息，进而对api列表或api属性信息进行处理，满足了soul网关同步要求的基本信息，并将api信息页面化，通过api详情能全面的获得api相关的全部属性信息，以及通过多条件限定查询加快了api查找的速率，使得用户操作更加简单快捷。
70.在本技术实施例的可选实施方式中，本技术实施例中的api可以应用于soul网关，当然，在其他应用场景中该aip也可以应用于其他api网关。
71.本技术实施例还提供了一种电子设备，如图3所示，包括处理器301、通信接口302、存储器303和通信总线304，其中，处理器301，通信接口302，存储器303通过通信总线304完成相互间的通信，
72.存储器303，用于存放计算机程序；
73.处理器301，用于执行存储器303上所存放的程序时，实现图1中的方法步骤。
74.该电子设备中的处理实现图1中的方法步骤，所带来的技术效果与上述图1中的api的处理方法的技术效果一致，在此不再赘述。
75.上述终端提到的通信总线可以是外设部件互连标准(peripheral component interconnect，简称pci)总线或扩展工业标准结构(extended industry standard architecture，简称eisa)总线等。该通信总线可以分为地址总线、数据总线、控制总线等。为便于表示，图3中仅用一条粗线表示，但并不表示仅有一根总线或一种类型的总线。
76.通信接口用于上述终端与其他设备之间的通信。
77.存储器可以包括随机存取存储器(random access memory，简称ram)，也可以包括非易失性存储器(non
‑
volatile memory)，例如至少一个磁盘存储器。可选的，存储器还可以是至少一个位于远离前述处理器的存储装置。
78.上述的处理器可以是通用处理器，包括中央处理器(central processing unit，简称cpu)、网络处理器(network processor，简称np)等；还可以是数字信号处理器(digital signal processing，简称dsp)、专用集成电路(application specific integrated circuit，简称asic)、现场可编程门阵列(field－programmable gate array，简称fpga)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。
79.在本技术提供的又一实施例中，还提供了一种计算机可读存储介质，该计算机可读存储介质中存储有指令，当其在计算机上运行时，使得计算机执行上述实施例中任一所述的api的处理方法。
80.在本技术提供的又一实施例中，还提供了一种包含指令的计算机程序产品，当其在计算机上运行时，使得计算机执行上述实施例中任一所述的api的处理方法。
81.在上述实施例中，可以全部或部分地通过软件、硬件、固件或者其任意组合来实现。当使用软件实现时，可以全部或部分地以计算机程序产品的形式实现。所述计算机程序产品包括一个或多个计算机指令。在计算机上加载和执行所述计算机程序指令时，全部或部分地产生按照本技术实施例所述的流程或功能。所述计算机可以是通用计算机、专用计算机、计算机网络、或者其他可编程装置。所述计算机指令可以存储在计算机可读存储介质中，或者从一个计算机可读存储介质向另一个计算机可读存储介质传输，例如，所述计算机指令可以从一个网站站点、计算机、服务器或数据中心通过有线(例如同轴电缆、光纤、数字用户线(dsl))或无线(例如红外、无线、微波等)方式向另一个网站站点、计算机、服务器或数据中心进行传输。所述计算机可读存储介质可以是计算机能够存取的任何可用介质或者是包含一个或多个可用介质集成的服务器、数据中心等数据存储设备。所述可用介质可以是磁性介质，(例如，软盘、硬盘、磁带)、光介质(例如，dvd)、或者半导体介质(例如固态硬盘solidstatedisk(ssd))等。
82.需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个
……”
限定的要素，并不排除在
包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。
83.本说明书中的各个实施例均采用相关的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于系统实施例而言，由于其基本相似于方法实施例，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。
84.以上所述仅为本技术的较佳实施例而已，并非用于限定本技术的保护范围。凡在本技术的精神和原则之内所作的任何修改、等同替换、改进等，均包含在本技术的保护范围内。