CN116932845A - 管理应用编程接口功能的呈现模式 - Google Patents

管理应用编程接口功能的呈现模式 Download PDF

Info

Publication number
CN116932845A
CN116932845A CN202210896924.9A CN202210896924A CN116932845A CN 116932845 A CN116932845 A CN 116932845A CN 202210896924 A CN202210896924 A CN 202210896924A CN 116932845 A CN116932845 A CN 116932845A
Authority
CN
China
Prior art keywords
api
selection
user interface
api functions
functions
Prior art date
Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
Pending
Application number
CN202210896924.9A
Other languages
English (en)
Inventor
C.阿纳尔卡斯特洛
P.安蒂诺里
E.维特曼
Current Assignee (The listed assignees may be inaccurate. Google has not performed a legal analysis and makes no representation or warranty as to the accuracy of the list.)
Red Hat
Original Assignee
Red Hat
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by Red Hat filed Critical Red Hat
Publication of CN116932845A publication Critical patent/CN116932845A/zh
Pending legal-status Critical Current

Links

Classifications

    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
    • G06F16/90—Details of database functions independent of the retrieved data types
    • G06F16/904—Browsing; Visualisation therefor
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F9/00—Arrangements for program control, e.g. control units
    • G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
    • G06F9/46—Multiprogramming arrangements
    • G06F9/54—Interprogram communication
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F9/00—Arrangements for program control, e.g. control units
    • G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
    • G06F9/44—Arrangements for executing specific programs
    • G06F9/451—Execution arrangements for user interfaces
    • G06F9/453—Help systems
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F16/00—Information retrieval; Database structures therefor; File system structures therefor
    • G06F16/90—Details of database functions independent of the retrieved data types
    • G06F16/95—Retrieval from the web
    • G06F16/955—Retrieval from the web using information identifiers, e.g. uniform resource locators [URL]
    • G06F16/9558—Details of hyperlinks; Management of linked annotations
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F3/00—Input arrangements for transferring data to be processed into a form capable of being handled by the computer; Output arrangements for transferring data from processing unit to output unit, e.g. interface arrangements
    • G06F3/01—Input arrangements or combined input and output arrangements for interaction between user and computer
    • G06F3/048—Interaction techniques based on graphical user interfaces [GUI]
    • G06F3/0484—Interaction techniques based on graphical user interfaces [GUI] for the control of specific functions or operations, e.g. selecting or manipulating an object, an image or a displayed text element, setting a parameter value or selecting a range
    • G—PHYSICS
    • G06—COMPUTING; CALCULATING OR COUNTING
    • G06F—ELECTRIC DIGITAL DATA PROCESSING
    • G06F9/00—Arrangements for program control, e.g. control units
    • G06F9/06—Arrangements for program control, e.g. control units using stored programs, i.e. using an internal store of processing equipment to receive or retain programs
    • G06F9/44—Arrangements for executing specific programs
    • G06F9/451—Execution arrangements for user interfaces

Landscapes

  • Engineering & Computer Science (AREA)
  • Theoretical Computer Science (AREA)
  • Software Systems (AREA)
  • General Engineering & Computer Science (AREA)
  • Physics & Mathematics (AREA)
  • General Physics & Mathematics (AREA)
  • Databases & Information Systems (AREA)
  • Human Computer Interaction (AREA)
  • Data Mining & Analysis (AREA)
  • User Interface Of Digital Computer (AREA)
  • Stored Programmes (AREA)

Abstract

用于提供应用编程接口功能的呈现模式的系统和方法。在一个实施方式中，经由用户接口接收与多个API功能中的一个或多个API功能有关的第一选择，其中第一选择指示对于任务一个或多个API功能的执行顺序。接收第二选择，第二选择指示多个API功能中的至少两个API功能之间的关系。根据第二选择设置至少两个API功能之间的关系。由处理设备使得一个或多个API功能根据第一选择被布置。经由用户接口呈现根据第一选择布置的一个或多个API功能。

Description

管理应用编程接口功能的呈现模式
技术领域
本公开总体上涉及应用编程接口，并且更特别地，涉及管理用于应用编程接口功能的呈现模式。
背景技术
应用编程接口(API)可以用于在两个或更多个软件应用之间交换数据。例如，安装在计算机系统上的软件应用的API可以通过发送执行API功能的请求来与另一计算机系统交换数据。该请求可以识别要执行的API功能，并且可以可选地包括一个或多个API参数。API规范通常用于通过提供文档来简化API，该文档描述了各种API功能、API参数、描述执行每个API功能的目的和结果的评论等。
发明内容
本公开的实施方式涉及管理用于应用编程接口功能的呈现模式。
可以由软件应用暴露的应用编程接口(API)可以包括引用其他应用可以调用的软件应用的各种功能的一组API呼叫。API呼叫可以识别要调用的功能，并且可以可选地指定功能的一个或多个输入或输出参数，以及功能的返回值。
软件应用的API规范可以包括API资源和/或API功能的形式化定义，从而使得另一软件应用能够与暴露API的软件应用交互。API资源可以被定义为具有类型和相关联的数据的对象。API资源定义可以包括API资源标识符、API资源类型、关系数据(例如，与其他API资源和API功能的关系，包括对在资源上操作的一个或多个功能的引用)以及允许另一软件应用使用API资源与该软件应用交互的任何附加信息。API功能定义可以包括API功能标识符、关系数据(包括对API资源的引用)、API输入和/或输出参数定义以及允许另一软件应用使用API功能来与该软件应用交互的任何附加信息。API功能可以是执行特定操作的程序指令序列。API参数定义可以包括API输入和/或输出参数、关系数据(例如，与API功能的关系)以及允许另一软件应用使用API参数与该软件应用交互的任何附加信息。API参数可以是API功能的值。在各种说明性示例中，给定软件应用的API规范可以由软件应用本身、由另一软件应用或由用户生成。
API规范可以用于通过提供描述API的所有相关信息的文档来简化API。然而，API规范不以有组织的方式捕获关于API的信息，诸如调用一组API功能以便实现某个任务或目标的具体顺序。因此，想要描述使用若干API来实现某个业务目标的用户(例如，工程师)将需要在API规范的不同部分之间导航以找到相关的API功能。尽管某些API规范可以包括线性序列中的一个API功能的输出和后续API功能的输入之间的链接，但是没有指定为了实现任务/目标而需要的API功能的完整流程的链接。
本公开的各方面通过提供用于应用编程接口功能的呈现模式来解决上述和其他缺陷。在一些实施例中，用户可以选择属于具体操作流程(即，执行某个任务所需的具体API功能流程)的一组API功能，并且用户可以指定在具体流程中调用API功能的顺序。用户还可以定义API功能之间的关系，诸如一个API功能的输出与后续API功能的输入之间的关系。在一些示例中，两个或更多个功能(例如，API功能A、API功能B等)的输出可以用作API功能X的输入。在一些示例中，API功能A的输出可以用作一个或多个API功能(例如，API功能B、API功能C等)的输入。在一些示例中，API功能A的输出可以用作API功能B的输入，并且API功能B的输出可以用作API功能C的输入，等等。在一些示例中，API功能B的输出可以用作API功能A的输入。在一些示例中，API功能C的输出和API功能D的输出可以用作API功能B的输入。用户可以另外包括包含相关信息的评论，诸如帮助描述API功能的具体流程的评论。用户指定的信息(例如，API功能、关系、评论等)可以经由图形用户接口(GUI)(例如，通过web应用和/或web浏览器插件)捕获。可以使用视觉动画经由GUI进一步呈现信息。视觉动画可以顺序地显示要在具体流程中调用的该组API功能中的API功能，包括用户已经为每个API功能指定的关系和/或评论。用户还可以使用允许用户从一个部分跳转到另一个部分的超链接来导航到(多个)API规范中的每个API功能。
本公开的各方面提供了用于应用编程接口操作的呈现模式，其允许用户捕获关于实现某个结果(例如，业务目标)所需的API功能的具体流程的信息，并使用视觉动画将信息呈现给用户，该视觉动画使得用户能够容易地导航API功能的具体流程并跟踪相关信息(例如，API功能之间的关系、附加评论等)。不是以随机顺序在API规范的各个部分之间导航并且需要记住相关信息以便实现某个结果，而是可以以有组织的方式向用户呈现信息。此外，不是使用仅链接到诸如OpenAPI规范中的线性序列中的后续操作的链接，而是可以向用户呈现定义API功能的具体流程内所需的完整步骤组的视觉动画和链接。因此，可以提高使用API规范来实现任务/目标(例如，业务目标)的效率和有效性。
附图说明
本公开通过示例而非限制的方式示出，并且当结合附图考虑时，可以参考以下详细描述更全面地理解本公开，其中：
图1描绘了根据本公开的一个或多个方面操作的示例系统架构的框图。
图2是根据本公开的一个或多个方面的用于管理应用编程接口功能的呈现模式的方法的流程图。
图3是根据本公开的一个或多个方面的用于管理应用编程接口功能的呈现模式的方法的流程图。
图4描绘了根据本公开的一个或多个方面操作的说明性计算机系统的框图。
图5描绘了示出根据本公开的一个或多个方面的计算机系统的一个实施方式的框图。
具体实施方式
图1是根据本公开的一个或多个方面的用于提供用于应用编程接口功能的呈现模式的系统架构的一个实施例的图。分布式计算机系统100可以包括通过网络115可通信地连接的客户端设备130、131和服务器设备110、112。可以存在任何数量的客户端设备130、131和任何数量的服务器设备110、112。网络115可以是私人网络(例如，局域网(LAN)、广域网(WAN)、内联网等)或公共网络(例如，因特网)。
客户端设备130、131和服务器设备110、112可以是服务器、工作站、个人计算机(PC)、移动电话、智能电话、移动计算设备、个人数字助理(PDA)、平板电脑、膝上型计算机、瘦客户端等。客户端设备130、131可以包括一个或多个中央处理单元(CPU)137A-137B、存储器138A-138B和存储设备139A-139B(例如，数据存储设备或大容量存储设备，诸如基于磁或光存储的磁盘、磁带或硬盘驱动器)。客户端设备130、131还可以包括一个或多个外围设备(未示出)，其可以包括网络设备、图形设备、系统组件(例如，桥接器、端口、总线)、媒体设备(例如，视频卡、声卡等)。
客户端设备130、131可以各自包括可以是图形用户接口(GUI)的用户接口133A、133B。客户端设备130、131可以各自包括浏览器135A、135B。每个浏览器135A、135B可以是web应用浏览器。浏览器135A、135B可以各自托管API规范136A、136B。API规范可以包括API资源、API功能和API参数的定义。在一个实施方式中，API规范中的定义可以包括API资源、API功能和API参数中的至少一个的名称和描述。参数还可以具有定义的数据类型，诸如整数、布尔、字符串等。在本公开的一些实施例中，用户可以经由浏览器135A和/或135B来选择API规范136A和/或136B上列出的一组API功能。在本公开的一些实施例中，用户可以经由与浏览器135A和/或135B相关联的web浏览器插件(图1中未示出)来选择API规范136A和/或136B上列出的一组API功能。在一些实施例中，用户还可以根据具体布置来布置该组API功能，指定一个或多个API功能之间的关系，并且经由浏览器135A和/或135B或经由web浏览器插件来添加附加评论以描述具体布置。
服务器设备110和112可以分别包括API规范管理器114A和114B。API规范管理器114A和/或114B可以跨多个服务器设备分布，如图1所示。可替代地，API规范管理器114A和/或114B可以安装在单个服务器设备上。
在一些实施例中，API规范管理器114A和/或114B可以经由浏览器135A和/或135B在用户接口133A和/或133B上向用户呈现(例如，显示)API规范136A和/或136B。在一些实施例中，API规范管理器114A和/或114B可以经由浏览器135A和/或135B在API存储库文档中呈现一个或多个API规范。API规范管理器114A和/或114B可以(即，从用户)接收要以具体布置调用的一个或多个API功能的选择，以便执行某个任务或实现某个目标。具体布置可以包括调用一个或多个API功能中的每一个的特定顺序。API规范管理器114A和/或114B还可以根据所选择的布置来布置一个或多个API功能。API规范管理器114A和/或114B可以使得API功能的布置在用户接口133A和/或133B上呈现给例如用户。在一些实施例中，在用户接口133A和/或133B上呈现API功能的布置可以包括生成视觉动画以表示布置，用户可以使用该视觉动画来在布置内导航API功能。在一些实施例中，生成视觉动画可以包括生成允许用户根据布置以连续顺序从一个API功能导航到另一个API功能的超链接。例如，用户可以如下选择API功能的布置：API功能“1”、API功能“10”、API功能“5”、API功能“6”。该布置指定调用API功能的顺序。生成视觉动画以表示特定布置可以包括生成允许用户以连续顺序从API功能“1”导航到API功能“10”、到API功能“5”以及到API功能“6”的超链接。超链接可以通过包括表示每个API功能的嵌入式超链接来允许用户从一个API功能导航到另一个API功能，用户可以经由GUI点击该嵌入式超链接以便从一个API功能导航到另一个API功能。在一些实施例中，生成视觉动画可以包括生成表示(例如，逻辑地和/或图形地)每个API功能的一个或多个GUI元素，诸如按钮、图像、图标等。每个GUI元素可以由用户点击，以便允许用户根据布置从一个API功能导航到另一个API功能。下文描述了关于API规范管理器114A、114B的进一步细节。
图2描绘了根据本公开的一个或多个方面的用于提供用于应用编程接口功能的呈现模式的方法200的框图。方法200可以由包括硬件(例如，电路、专用逻辑、可编程逻辑、微代码等)、软件(例如，在处理器上运行以执行硬件模拟的指令)或其组合的处理逻辑来执行。方法200或其各个功能、例程、子例程或操作中的每一个可以由实现该方法的计算机系统(例如，图1的客户端设备130、131和/或服务器设备110、112)的一个或多个处理器执行。在说明性示例中，方法200可以由单个处理线程执行。替代地，方法200可以由两个或更多个处理线程执行，每个线程实现该方法的一个或多个单独的功能、例程、子例程或操作。在说明性示例中，实现方法200的处理线程可以被同步(例如，使用信号量、关键区段或其他线程同步机制)。
为了简化说明，本公开的方法被描绘和描述为一系列动作。然而，根据本公开的动作可以以各种顺序发生和/或与本文未呈现和描述的其他动作同时发生。此外，可能不需要所有示出的动作来实现根据所公开的主题的方法。另外，可以理解，方法可以替代地经由状态图或事件表示为一系列相互关联的状态。另外，应当理解，本说明书中公开的方法能够存储在制品上，以便于将这些方法传输和传送到计算设备。如本文所使用的术语“制品”旨在涵盖可从任何计算机可读设备或存储介质访问的计算机程序。
参考图2，在操作220处，处理逻辑接收与一个或多个API功能有关的选择。选择一个或多个API功能可以包括接收用户与浏览器(例如，图1的浏览器135A和/或135B)交互或与从浏览器外部扩展的web浏览器插件交互的选择。用户可以点击、输入或以其他方式指示用户期望包括的每个API功能，例如，在API功能的具体流程中，以便执行某个任务和/或实现某个目标，如上所述。例如，如果在API规范中存在连续列出的API功能1-5(即，API功能1、2、3、4、5)，则用户可以将API功能的顺序选择为API功能3、API功能2、API功能1、API功能4和API功能5。在一些实施例中，可以从包括在一个或多个API规范的每个API规范中的一组API功能中选择一个或多个API功能。
在一些实施例中，处理逻辑经由客户端设备(例如，图1的客户端设备130和/或131)的用户接口(例如，图1的用户接口133A和/或133B)呈现一个或多个API规范(例如，图1的API规范136A和/或136B)。每个API规范可以各自引用一组API功能。一个或多个API规范还可以定义被引用的每个API功能。一个或多个API规范还可以包括一个或多个API资源、一个或多个输入和/或输出API参数等，如上所述。在一些实施例中，处理逻辑可以经由浏览器(例如，图1的浏览器135A和/或135B)上的用户接口呈现一个或多个API规范。在一些实施例中，处理逻辑可以响应于经由客户端设备从用户接收到请求而呈现一个或多个API规范。在一些实施例中，处理逻辑可以呈现包括一个或多个API规范的API规范存储库。API规范存储库可以是在单个文档内编译一个或多个API规范的文档。在一些实施例中，每个API规范可以是OpenAPI规范文档。在一些实施例中，响应于呈现一个或多个API操作，处理逻辑可以接收与一个或多个API功能有关的选择，如本文中操作220处所述。
在操作230处，处理逻辑使得处理设备根据在操作220处接收的选择来布置一个或多个API功能。在一些实施例中，使得根据接收到的选择来布置一个或多个API功能可以包括以由选择指定的顺序对一个或多个API功能进行排序。例如，如关于操作220所描述的，用户可以将API功能的顺序选择为API功能3、API功能2、API功能1、API功能4和API功能5。处理逻辑可以根据用户的指定布置来布置(即，排序)API功能。
在操作240处，处理逻辑经由用户接口呈现根据选择布置的一个或多个API功能。在一些实施例中，呈现根据选择布置的一个或多个API功能包括生成一个或多个视觉动画。处理逻辑可以经由用户接口呈现一个或多个视觉动画。在一些实施例中，生成视觉动画可以包括生成允许用户根据布置以连续顺序从一个API功能导航到另一个API功能的超链接。例如，用户可以如下选择API功能的布置：API功能“1”、API功能“10”、API功能“5”、API功能“6”。该布置指定调用API功能的顺序。生成视觉动画以表示特定布置可以包括生成允许用户以连续顺序从API功能“1”导航到API功能“10”、到API功能“5”以及到API功能“6”的超链接。超链接可以通过包括表示每个API功能的嵌入式超链接来允许用户从一个API功能导航到另一个API功能，用户可以经由GUI点击该嵌入式超链接以便从一个API功能导航到另一个API功能。每个超链接可以与每个API功能相关联，即，每个超链接可以引用每个API规范内的API操作的位置。在一些实施例中，生成视觉动画可以包括生成表示(例如，逻辑地和/或图形地)每个API功能的一个或多个GUI元素，诸如按钮、图像、图标等。每个GUI元素可以由用户点击，以便允许用户根据布置从一个API功能导航到另一个API功能。
图3描绘了根据本公开的一个或多个方面的用于提供用于应用编程接口功能的呈现模式的方法300的框图。方法300可以由包括硬件(例如，电路、专用逻辑、可编程逻辑、微代码等)、软件(例如，在处理器上运行以执行硬件模拟的指令)或其组合的处理逻辑来执行。方法300或其各个功能、例程、子例程或操作中的每一个可以由实现该方法的计算机系统(例如，图1的客户端设备130、131和/或服务器设备110、112)的一个或多个处理器执行。在说明性示例中，方法300可以由单个处理线程执行。替代地，方法300可以由两个或更多个处理线程执行，每个线程实现该方法的一个或多个单独的功能、例程、子例程或操作。在说明性示例中，实现方法300的处理线程可以被同步(例如，使用信号量、关键区段或其他线程同步机制)。
为了简化说明，本公开的方法被描绘和描述为一系列动作。然而，根据本公开的动作可以以各种顺序发生和/或与本文未呈现和描述的其他动作同时发生。此外，可能不需要所有示出的动作来实现根据所公开的主题的方法。另外，可以理解，方法可以替代地经由状态图或事件表示为一系列相互关联的状态。另外，应当理解，本说明书中公开的方法能够存储在制品上，以便于将这些方法传输和传送到计算设备。如本文所使用的术语“制品”旨在涵盖可从任何计算机可读设备或存储介质访问的计算机程序。
参考图3，在操作310处，处理逻辑经由客户端设备(例如，图1的客户端设备130和/或131)的用户接口(例如，图1的用户接口133A和/或133B)呈现一个或多个API规范(例如，图1的API规范136A和/或136B)。一个或多个API规范可以各自引用一组API功能。一个或多个API规范还可以定义被引用的每个API功能。一个或多个API规范还可以包括一个或多个API资源、一个或多个输入和/或输出API参数等，如上所述。在一些实施例中，处理逻辑可以响应于经由客户端设备从用户接收到请求而呈现一个或多个API规范。在一些实施例中，处理逻辑可以呈现包括一个或多个API规范的API规范存储库。API规范存储库可以是在单个文档内编译一个或多个API规范的文档。在一些实施例中，每个API规范可以是OpenAPI规范文档。
在操作320处，处理逻辑接收与一个或多个API功能有关的选择。选择一个或多个API功能可以包括接收用户与浏览器(例如，图1的浏览器135A和/或135B)交互或与从浏览器外部扩展的web浏览器插件交互的选择。用户可以点击、输入或以其他方式指示用户期望包括的每个API功能，例如，在API功能的具体流程中，以便执行某个任务和/或实现某个目标，如上所述。例如，如果在API规范中存在连续列出的API功能1-5(即，API功能1、2、3、4、5)，则用户可以将API功能的顺序选择为API功能3、API功能2、API功能1、API功能4和API功能5。在一些实施例中，可以从包括在一个或多个API规范的每个API规范中的该组API功能中选择一个或多个API功能。
在操作330处，处理逻辑使得处理设备根据在操作320处接收的选择来布置一个或多个API功能。在一些实施例中，使得根据接收到的选择来布置一个或多个API功能可以包括以由选择指定的顺序对一个或多个API功能进行排序。例如，如关于操作220所描述的，用户可以将API功能的顺序选择为API功能3、API功能2、API功能1、API功能4和API功能5。处理逻辑可以根据用户的指定布置来布置(即，排序)API功能。
在操作340处，处理逻辑生成一个或多个视觉动画。可以基于选择来生成一个或多个视觉动画。在一些实施例中，生成视觉动画可以包括生成允许用户根据布置以连续顺序从一个API功能导航到另一个API功能的超链接。例如，用户可以如下选择API功能的布置：API功能“1”、API功能“10”、API功能“5”、API功能“6”。该布置指定调用API功能的顺序。生成视觉动画以表示特定布置可以包括生成允许用户以连续顺序从API功能“1”导航到API功能“10”、到API功能“5”以及到API功能“6”的超链接。超链接可以通过包括表示每个API功能的嵌入式超链接来允许用户从一个API功能导航到另一个API功能，用户可以经由GUI点击该嵌入式超链接以便从一个API功能导航到另一个API功能。每个超链接可以与每个API功能相关联，即，每个超链接可以引用每个API规范内的API操作的位置。在一些实施例中，生成视觉动画可以包括生成表示(例如，逻辑地和/或图形地)每个API功能的一个或多个GUI元素，诸如按钮、图像、图标等。每个GUI元素可以由用户点击，以便允许用户根据布置从一个API功能导航到另一个API功能。
在操作350处，处理逻辑经由用户接口显示一个或多个视觉动画。在一些实施例中，视觉动画可以使用户能够经由用户接口通过选择进行导航，其中选择表示要调用的API功能的具体流，以便执行某个任务和/或实现某个目标(即，特定业务结果)。
在操作360处，处理逻辑接收与在操作320处选择的一个或多个API功能之间的一个或多个关联(例如，关系)有关的另一选择。例如，选择可以涉及一个API功能的输出是否应该用作所选择的API功能内的另一(例如，后续)API功能的输入。例如，API功能A的输出可以用作API功能B的输入。在一些示例中，两个或更多个功能(例如，API功能A、API功能B等)的输出可以用作API功能X的输入。在一些示例中，API功能A的输出可以用作一个或多个API功能(例如，API功能B、API功能C等)的输入。在一些示例中，API功能A的输出可以用作API功能B的输入，API功能B的输出可以用作API功能C的输入，等等。在一些示例中，API功能B的输出可以用作API功能A的输入。在一些示例中，API功能C的输出和API功能D的输出可以用作API功能B的输入。在一些实施例中，处理逻辑可以经由客户端设备从用户接收选择。在一些实施例中，从用户接收选择可以包括用户经由用户接口与浏览器(例如，图1的浏览器135A和/或135B)交互。与浏览器交互可以包括点击、输入或以其他方式选择用户期望包括的一个或多个关联。
在操作370处，处理逻辑经由用户接口呈现根据选择的一个或多个API功能之间的一个或多个关联。在一些实施例中，呈现根据选择的一个或多个关联包括生成表示一个或多个关联的一个或多个视觉动画。例如，生成表示一个或多个关联的一个或多个视觉动画可以包括为每个关联生成超链接和/或一个或多个GUI元素(例如，按钮、图像、图标等)。处理逻辑可以经由用户接口呈现表示一个或多个关联的一个或多个视觉动画。
在操作380处，处理逻辑接收与一个或多个API功能有关的一个或多个评论。在一些实施例中，一个或多个评论可以包括进一步的信息/细节，诸如关于每个API功能、具体流程(即，API功能的选择)、要使用具体流程实现的特定目标/任务等的细节。在一些实施例中，处理逻辑可以经由客户端设备从用户接收一个或多个评论作为选择。在一些实施例中，从用户接收一个或多个评论可以包括用户经由用户接口与浏览器(例如，图1的浏览器135A和/或135B)交互。与浏览器交互可以包括输入或以其他方式选择用户期望包括的一个或多个评论。
在操作390处，处理逻辑经由用户接口呈现与一个或多个API功能有关的一个或多个评论。在一些实施例中，呈现与一个或多个API功能有关的一个或多个评论包括生成表示一个或多个评论的一个或多个视觉动画。例如，生成表示一个或多个评论的一个或多个视觉动画能够包括为每个评论生成超链接和/或一个或多个GUI元素(例如，按钮、图像、图标等)。处理逻辑可以经由用户接口呈现表示一个或多个评论的一个或多个视觉动画。
图4是根据本公开的一个或多个方面操作的计算机系统400的框图示例。计算机系统400可以与图1的计算机系统100相同或类似，并且可以包括一个或多个处理设备和一个或多个存储器设备。在所示的示例中，计算机系统400可以包括API规范管理器模块420(例如，图1的API规范管理器114A和/或114B)。可替代地，API规范管理器模块420的功能可以被划分为多个子模块。
API规范管理器模块420负责经由客户端设备(例如，图1的客户端设备130、131)上的用户接口呈现一个或多个API规范。API规范管理器模块420也是用于接收与由每个API规范引用的一组API功能中的一个或多个API功能有关的选择的响应。可以从用户接收选择。该选择可以指示用于执行特定任务和/或实现某个目标的一个或多个API功能的执行顺序。API规范管理器模块420还可以使得根据所接收的选择来布置一个或多个API功能。API规范管理器模块420还可以经由用户接口呈现根据选择布置的一个或多个API功能。上文参考图1-3描述了关于API规范管理器模块420的进一步细节。
图5是计算机系统500的示例性形式的机器的图形表示，其中可以执行用于使机器执行本文讨论的任何一种或多种方法的一组指令。在各种说明性示例中，计算机系统500可以对应于图1的计算机系统100。
在某些实施例中，计算机系统500可以连接(例如，联网)到局域网(LAN)、内联网、外联网或互联网中的其他机器。机器可以在客户端-服务器网络环境中以服务器或客户端机器的身份操作，或者在对等(或分布式)网络环境中作为对等机器操作。计算机系统500可以由个人计算机(PC)、平板PC、机顶盒(STB)、个人数字助理(PDA)、蜂窝电话、网络设备、服务器、网络路由器、交换机或桥接器、或能够执行指定要由该设备采取的动作的一组指令(顺序的或以其他方式)的任何机器提供。此外，虽然仅示出了单个机器，但是术语“计算机”还应被视为包括单独或联合执行一组(或多组)指令以执行本文所讨论的任何一种或多种方法的计算机的任何集合。
示例性计算机系统500可以包括经由总线530彼此通信的处理设备502、主存储器504(例如，只读存储器(ROM)、闪存、动态随机存取存储器(DRAM)(诸如同步DRAM(SDRAM)等)、静态存储器506(例如，闪存、静态随机存取存储器(SRAM)等)和数据存储设备518。
处理设备502表示一个或多个通用处理设备，诸如微处理器、中央处理单元等。更特别地，处理设备可以是复杂指令组计算(CISC)微处理器、精简指令组计算(RISC)微处理器、超长指令字(VLIW)微处理器、实现其他类型的指令组的微处理器或实现指令组类型的组合的微处理器。处理设备502还可以是一个或多个专用处理设备，诸如专用集成电路(ASIC)、现场可编程门阵列(FPGA)、数字信号处理器(DSP)、网络处理器等。处理设备502可以被配置为管理用于如本文所讨论的应用编程接口操作的呈现模式。
计算机系统500还可以包括网络接口设备508。计算机系统500还可以包括视频显示单元510(例如，液晶显示器(LCD)或阴极射线管(CRT))、字母数字输入设备512(例如，键盘)、光标控制设备514(例如，鼠标)和信号生成设备516(例如，扬声器)。
数据存储设备518可以包括机器可读存储介质(或更具体地，计算机可读存储介质)520，其具有体现本文描述的功能的任何一种或多种方法的一组或多组指令522。指令522还可以在由计算机系统500执行期间完全或至少部分地驻留在主存储器504内和/或处理设备502内；主存储器504和处理设备502也构成机器可读存储介质。还可以经由网络接口设备508通过网络526发送或接收指令522。
机器可读存储介质528还可以用于持久地存储设备队列方式逻辑。虽然机器可读存储介质528在示例性实施例中被示出为单个介质，但是术语“计算机可读存储介质”应当被视为包括存储一组或多组指令的单个介质或多个介质(例如，集中式或分布式数据库和/或相关联的缓存和服务器)。术语“计算机可读存储介质”还应被视为包括能够存储或编码一组指令以供机器执行并且使机器执行本公开的任何一种或多种方法的任何介质。因此，术语“机器可读存储介质”应被视为包括但不限于固态存储器以及光学和磁性介质。
本文描述的组件和其他特征可以实现为分立的硬件组件或集成在诸如ASIC、FPGA、DSP或类似设备的硬件组件的功能中。此外，这些组件可以被实现为硬件设备内的固件或功能电路。此外，这些组件可以以硬件设备和软件组件的任何组合来实现。
详细描述的一些部分是根据对计算机存储器内的数据比特的操作的方法和符号表示来呈现的。这些描述和表示是数据处理领域的技术人员用来最有效地将他们的工作实质传达给本领域其他技术人员的手段。这里的方法通常被认为是导致期望结果的自相一致的步骤序列。这些步骤是需要物理量的物理操纵的那些步骤。通常，尽管不是必须的，但这些量采取能够被存储、传输、组合、比较和以其他方式操纵的电信号或磁信号的形式。主要出于通用的原因，已经证明有时将这些信号称为比特、值、元素、符号、字符、术语、数字等是方便的。
然而，应当记住，所有这些和类似的术语都与适当的物理量相关联，并且仅仅是应用于这些量的方便标签。除非另有具体说明，否则从上述讨论中显而易见的是，应当理解，在整个说明书中，利用诸如“启用”、“发送”、“请求”、“识别”、“查询”、“检索”、“转发”、“确定”、“传递”、“处理”、“发布”、“测量”、“缓存”、“监视”、“映射”、“估计”、“计算”、“禁用”、“检测”等术语的讨论是指计算机系统或类似电子计算设备的动作和过程，该动作和过程操纵表示为计算机系统的寄存器和存储器内的物理(电子)量的数据并将表示为计算机系统的寄存器和存储器内的物理(电子)量的数据转换为类似地表示为计算机系统存储器或寄存器或其他这样的信息存储、传输或显示设备内的物理量的其他数据。
实施例还涉及用于执行本文中的操作的装置。该装置可以为所需目的而专门构造，或者它可以包括由存储在计算机中的计算机程序选择性地激活或重新配置的通用计算机。这样的计算机程序可以存储在计算机可读存储介质中，诸如但不限于任何类型的盘(包括软盘、光盘、CD-ROM和磁光盘)、只读存储器(ROM)、随机存取存储器(RAM)、可擦除可编程ROM(EPROM)、电可擦除可编程ROM(EEPROM)、磁卡或光卡、闪存设备(包括通用串行总线(USB)存储设备(例如，USB密钥驱动器))或适于存储电子指令的任何类型的介质，其中的每一个可以耦合到计算机系统总线。
本文描述的方法和说明性示例并非固有地与任何特定计算机或其他装置相关。根据本文的教导，各种通用系统可以与程序一起使用，或者可以证明构造更专用的装置来执行所需的方法200和/或300和/或它们各自的功能、例程、子例程或操作中的每一个是方便的。在上述说明书中阐述了各种这些系统的结构的示例。
应当理解，上述说明书旨在是说明性的而非限制性的。在阅读和理解上述说明书后，许多其他实施例对于本领域技术人员将是显而易见的。尽管已经参考具体示例性实施例描述了本公开，但是将认识到，本公开不限于所描述的实施例，而是可以在所附权利要求的精神和范围内通过修改和变更来实践。因此，说明书和附图被认为是说明性的而不是限制性的。因此，本公开的范围应当参考所附权利要求以及这些权利要求所享有的等同物的全部范围来确定。

Claims (20)

1.一种用于提供应用编程接口功能的呈现模式的方法，包括：
由处理设备经由用户接口接收与多个API功能中的一个或多个API功能有关的第一选择，其中所述第一选择指示对于任务所述一个或多个API功能的执行顺序；
接收第二选择，所述第二选择指示所述多个API功能中的至少两个API功能之间的关系；
根据所述第二选择确定所述至少两个API功能之间的关系；
由所述处理设备使得所述一个或多个API功能根据所述第一选择被布置；以及
经由所述用户接口呈现根据所述第一选择布置的所述一个或多个API功能。
2.根据权利要求1所述的方法，还包括：
经由所述用户接口呈现根据所述第二选择的所述至少两个API功能之间的所述关系。
3.根据权利要求1所述的方法，还包括：
接收与所述多个API功能中的所述一个或多个API功能有关的一个或多个评论；以及
经由所述用户接口呈现与所述一个或多个API功能有关的所述一个或多个评论。
4.根据权利要求1所述的方法，还包括：
经由所述用户接口呈现一个或多个API规范，所述一个或多个API规范引用所述多个API功能，其中，所述一个或多个API规范由web浏览器应用托管，并且其中，所述第一选择是从经由所述用户接口与所述web浏览器应用交互的用户接收的。
5.根据权利要求1所述的方法，还包括：
经由所述用户接口呈现一个或多个API规范，所述一个或多个API规范引用所述多个API功能，其中，所述一个或多个API规范由web浏览器应用托管，并且其中，所述第一选择是从经由所述用户接口与web浏览器插件交互的用户接收的。
6.根据权利要求1所述的方法，其中，呈现根据所述第一选择布置的所述一个或多个API功能包括：
根据所述第一选择生成一个或多个视觉动画；以及
在所述用户接口上显示根据所述第一选择的所述一个或多个视觉动画。
7.根据权利要求6所述的方法，还包括：
生成与所述一个或多个API功能中的每个API功能相关联的一个或多个超链接；
经由所述用户接口呈现所述一个或多个超链接；以及
响应于接收到对超链接的选择，由所述处理设备使得所述用户接口显示与所述超链接相关联的所述API功能。
8.一种用于提供应用编程接口功能的呈现模式的系统，包括：
存储器；
处理设备，所述处理设备可操作地耦合到所述存储器，所述处理设备被配置为：
由所述处理设备经由用户接口接收与多个API功能中的一个或多个API功能有关的第一选择，其中所述第一选择指示对于任务所述一个或多个API功能的执行顺序；
接收第二选择，所述第二选择指示所述多个API功能中的至少两个API功能之间的关系；
根据所述第二选择设置所述至少两个API功能之间的所述关系；
由所述处理设备使得所述一个或多个API功能根据所述第一选择被布置；以及
经由所述用户接口呈现根据所述第一选择布置的所述一个或多个API功能。
9.根据权利要求8所述的系统，还包括：
经由所述用户接口呈现根据所述第二选择的所述至少两个API功能之间的所述关系。
10.根据权利要求8所述的系统，还包括：
接收与所述多个API功能中的所述一个或多个API功能有关的一个或多个评论；以及
经由所述用户接口呈现与所述一个或多个API功能有关的所述一个或多个评论。
11.根据权利要求8所述的系统，还包括：
经由所述用户接口呈现一个或多个API规范，所述一个或多个API规范引用所述多个API功能，其中，所述一个或多个API规范由web浏览器应用托管，并且其中，所述第一选择是从经由所述用户接口与所述web浏览器应用交互的用户接收的。
12.根据权利要求8所述的系统，还包括：
经由所述用户接口呈现一个或多个API规范，所述一个或多个API规范引用所述多个API功能，其中，所述一个或多个API规范由web浏览器应用托管，并且其中，所述第一选择是从经由所述用户接口与web浏览器插件交互的用户接收的。
13.根据权利要求8所述的系统，其中呈现根据所述第一选择布置的所述一个或多个API功能包括：
根据所述第一选择生成一个或多个视觉动画；以及
在所述用户接口上显示根据所述第一选择的所述一个或多个视觉动画。
14.一种非暂时性计算机可读存储介质，包括指令，所述指令在由处理设备执行时使所述处理设备执行操作，所述操作包括：
由所述处理设备经由用户接口接收与多个API功能中的一个或多个API功能有关的第一选择，其中所述第一选择指示对于任务所述一个或多个API功能的执行顺序；
接收第二选择，所述第二选择指示所述多个API功能中的至少两个API功能之间的关系；
根据所述第二选择设置所述至少两个API功能之间的所述关系；
由所述处理设备使得所述一个或多个API功能根据所述第一选择被布置；以及
经由所述用户接口呈现根据所述第一选择布置的所述一个或多个API功能。
15.根据权利要求14所述的非暂时性计算机可读存储介质，还包括：
经由所述用户接口呈现根据所述第二选择的所述至少两个API功能之间的所述关系。
16.根据权利要求14所述的非暂时性计算机可读存储介质，还包括：
接收与所述多个API功能中的所述一个或多个API功能有关的一个或多个评论；以及
经由所述用户接口呈现与所述一个或多个API功能有关的所述一个或多个评论。
17.根据权利要求14所述的非暂时性计算机可读存储介质，还包括：
经由所述用户接口呈现一个或多个API规范，所述一个或多个API规范引用所述多个API功能，其中，所述一个或多个API规范由web浏览器应用托管，并且其中，所述第一选择是从经由所述用户接口与所述web浏览器应用交互的用户接收的。
18.根据权利要求14所述的非暂时性计算机可读存储介质，还包括：
经由所述用户接口呈现一个或多个API规范，所述一个或多个API规范引用所述多个API功能，其中，所述一个或多个API规范由web浏览器应用托管，并且其中，所述第一选择是从经由所述用户接口与web浏览器插件交互的用户接收的。
19.根据权利要求14所述的非暂时性计算机可读存储介质，其中，呈现根据所述第一选择布置的所述一个或多个API功能包括：
根据所述第一选择生成一个或多个视觉动画；以及
在所述用户接口上显示根据所述第一选择的所述一个或多个视觉动画。
20.根据权利要求19所述的非暂时性计算机可读存储介质，还包括：
生成与所述一个或多个API功能中的每个API功能相关联的一个或多个超链接；
经由所述用户接口呈现所述一个或多个超链接；以及
响应于接收到对超链接的选择，由所述处理设备使得所述用户接口显示与所述超链接相关联的所述API功能。
CN202210896924.9A 2022-04-05 2022-07-28 管理应用编程接口功能的呈现模式 Pending CN116932845A (zh)

Applications Claiming Priority (2)

Application Number Priority Date Filing Date Title
US17/713,769 2022-04-05
US17/713,769 US11915063B2 (en) 2022-04-05 2022-04-05 Managing a presentation mode for application programming interface functions

Publications (1)

Publication Number Publication Date
CN116932845A true CN116932845A (zh) 2023-10-24

Family

ID=83228755

Family Applications (1)

Application Number Title Priority Date Filing Date
CN202210896924.9A Pending CN116932845A (zh) 2022-04-05 2022-07-28 管理应用编程接口功能的呈现模式

Country Status (3)

Country Link
US (1) US11915063B2 (zh)
EP (1) EP4258112A1 (zh)
CN (1) CN116932845A (zh)

Family Cites Families (13)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US7761591B2 (en) * 2005-12-16 2010-07-20 Jean A. Graham Central work-product management system for coordinated collaboration with remote users
US20110099463A1 (en) * 2006-07-14 2011-04-28 Molsoft Llc Structured documents and systems, methods and computer programs for creating, producing and displaying three dimensional objects and other related information in structured documents
US20150012451A1 (en) * 2013-03-12 2015-01-08 Scala Hosting Llc Social network prestige program
US9778924B2 (en) 2013-06-06 2017-10-03 Wipro Limited Platform for enabling creation and use of an API for a specific solution
US9886247B2 (en) 2014-10-30 2018-02-06 International Business Machines Corporation Using an application programming interface (API) data structure in recommending an API composite
US9959198B1 (en) 2016-05-26 2018-05-01 Google Llc Simulated testing of API
WO2018025030A2 (en) * 2016-08-01 2018-02-08 Zone V Ltd Smartphone accessory for visually impaired or elderly users
US9823950B1 (en) * 2016-08-16 2017-11-21 International Business Machines Corporation Dynamically forming and executing application programming interface pipelines
US10511777B2 (en) * 2016-11-08 2019-12-17 Thomas Nichols Personal care device with camera
CN111279309A (zh) 2017-09-30 2020-06-12 甲骨文国际公司 基于环境要求的容器部署
US11467887B1 (en) * 2018-03-12 2022-10-11 Palantir Technologies Inc. Application programming interface (API) management and development
US11381663B1 (en) * 2019-10-16 2022-07-05 BlueOwl, LLC Eventing systems and methods to facilitate robust event processing
US11481089B2 (en) * 2020-08-11 2022-10-25 Xano, Inc. Graphical user interface to configure parameters of an API based on user inputs

Also Published As

Publication number Publication date
US20230315542A1 (en) 2023-10-05
EP4258112A1 (en) 2023-10-11
US11915063B2 (en) 2024-02-27

Similar Documents

Publication Publication Date Title
US11755387B1 (en) Updating code of an app feature based on a value of a query feature
US11593400B1 (en) Automatic triage model execution in machine data driven monitoring automation apparatus
US10942960B2 (en) Automatic triage model execution in machine data driven monitoring automation apparatus with visualization
US10997190B2 (en) Context-adaptive selection options in a modular visualization framework
US8099673B2 (en) User interface annotations
US8589876B1 (en) Detection of central-registry events influencing dynamic pointers and app feature dependencies
US9396046B2 (en) Graph based data model for API ecosystem insights
US20130318514A1 (en) Map generator for representing interrelationships between app features forged by dynamic pointers
US20110047415A1 (en) Debugging of business flows deployed in production servers
CN112720452A (zh) 根据自动检测到的目标标签来命名机器人流程自动化活动
JP2019520649A (ja) プロセス視覚化プラットフォーム
US20100125541A1 (en) Popup window for error correction
US8171348B2 (en) Data consistency in long-running processes
US11947443B2 (en) Robotic process automation (RPA) debugging systems and methods
RU2461058C2 (ru) Определяемый помощник по приложениям
US9804915B2 (en) Integrated production support
WO2021072742A1 (en) Assessing an impact of an upgrade to computer software
US20230236712A1 (en) Browser-Based Robotic Process Automation (RPA) Robot Design Interface
US10579227B1 (en) Identifying missed interactions
US10719206B1 (en) Measuring unresponsive interactions
JP2020004280A (ja) 表示制御装置、表示制御方法、および表示制御プログラム
JP2023152695A (ja) ロボティックプロセスオートメーション（ｒｐａ）ロボットを設計するためにブラウザを使用するシステムおよび方法
US11915063B2 (en) Managing a presentation mode for application programming interface functions
US11966566B2 (en) Mapping interactive UI elements to RPA object repositories for RPA development
JP5269660B2 (ja) 問題点管理システム

Legal Events

Date Code Title Description
PB01 Publication
PB01 Publication
SE01 Entry into force of request for substantive examination
SE01 Entry into force of request for substantive examination