API Governance Enforcement Architecture
Disclosed herein are system, method, and computer program product embodiments for providing an architecture to support a semantic validation technique. The system includes a governance console that carries out data management functionalities to support the validation. Such functionalities include generating, storing and publishing validation profiles that are used by a validation service for validating an asset, a validation reporter that receives and stores validation reports and performs notification functions to notify relevant individuals of the validation results, as well as a profile runner and associations manager that directly support the validation service.
1 . A method of providing governance enforcement for a plurality of application program interfaces (APIs) provided by a cloud computing environment, comprising:
providing a user interface configured to execute commands that perform validation functions for APIs associated with nodes of the cloud computing environment, the commands including a validate command configured to test a specified API associated with a node;
generating a validation profile that includes a corresponding severity level and rules applicable to the specified API, the rules including a specification of test data for the specified API independent of one or more data formats supported by the specified API;
storing the validation profile among a plurality of validation profiles available for use in validating the APIs;
generating a first set of data in the one or more data formats supported by the specified API based on the validation profile;
validating the specified API using the first set of data in the one or more data formats supported by the specified API; and
generating a validation report that indicates a validation status of the specified API including a severity indication.
2 . The method of claim 1 , further comprising performing a notification operation based on the validation report.
3 . The method of claim 2 , wherein the notification operation includes transmitting a notification to different individuals based on the severity indication.
4 . The method of claim 1 , wherein the specified API includes an API specification document.
5 . The method of claim 1 , further comprising publishing, to a cloud storage, a plurality of validation profiles that are selectable to run against the APIs.
6 . The method of claim 1 , further comprising determining that a set of the APIs are associated with a first validation profile, the first validation profile comprising a rule set applicable to an API specification type.
7 . The method of claim 3 , wherein the different individuals for notification are defined within a notification profile associated with the specified API.
8 . A device, comprising:
a display interface configured to provide a user interface configured to execute commands that perform validation functions for APIs associated with nodes of the cloud computing environment, the commands including a validate command configured to test a specified API associated with a node; and
one or more processors configured to:
generate a validation profile that includes a corresponding severity level and rules applicable to the specified API, the rules including a specification of test data for the specified API independent of one or more data formats supported by the specified API;
store the validation profile among a plurality of validation profiles available for use in validating the APIs;
generate a first set of data in the one or more data formats supported by the specified API based on the validation profile;
validate the specified API using the first set of data in the one or more data formats supported by the specified API; and
generate a validation report that indicates a validation status of the specified API including a severity indication.
9 . The device of claim 8 , the one or more processors further configured to perform a notification operation based on the validation report.
10 . The device of claim 9 , wherein the notification operation includes transmitting a notification to different individuals based on the severity indication.
11 . The device of claim 8 , wherein the specified API includes an API specification document.
12 . The device of claim 8 , wherein the one or more processors are further configured to further comprising publish, to a cloud storage, a plurality of validation profiles that are selectable to run against the APIs.
13 . The device of claim 8 , wherein the one or more processors are further configured to determine that a set of the APIs are associated with a first validation profile, the first validation profile comprising a rule set applicable to an API specification type.
14 . The device of claim 10 , wherein the different individuals for notification are defined within a notification profile associated with the specified API.
15 . A non-transitory computer-readable storage medium having stored thereon instructions that, when executed by one or more processors of a computing device, cause the computing device to perform operations, comprising:
providing a user interface configured to execute commands that perform validation functions for APIs associated with nodes of the cloud computing environment, the commands including a validate command configured to test a specified API associated with a node;
generating a validation profile that includes a corresponding severity level and rules applicable to the specified API, the rules including a specification of test data for the specified API independent of one or more data formats supported by the specified API;
storing the validation profile among a plurality of validation profiles available for use in validating the APIs;
generating a first set of data in the one or more data formats supported by the specified API based on the validation profile;
validating the specified API using the first set of data in the one or more data formats supported by the specified API; and
generating a validation report that indicates a validation status of the specified API including a severity indication.
16 . The computer-readable storage medium of claim 15 , the operations further comprising performing a notification operation based on the validation report.
17 . The computer-readable storage medium of claim 16 , wherein the notification operation includes transmitting a notification to different individuals based on the severity indication.
18 . The computer-readable storage medium of claim 15 , wherein the specified API includes an API specification document.
19 . The computer-readable storage medium of claim 15 , the operations further comprising publishing, to a cloud storage, a plurality of validation profiles that are selectable to run against the APIs.
20 . The computer-readable storage medium of claim 15 , the operations further comprising determining that a set of the APIs are associated with a first validation profile, the first validation profile comprising a rule set applicable to an API specification type.