API Governance

Anypoint API Governance:
Anypoint API Governance is a component of Anypoint

Platform that enables you to apply governance rules to
your APIs as part of the API lifecycle.
o Improve your organization’s API quality: Identify conformance issues in governed APIs and take steps to
resolve them.
o Share and enforce governance best practices: Customize and publish governance rulesets to share and
enforce organization-specific best practices with your developers.
o Apply consistent rules from design time to deployment: Apply governance rulesets from design time to
deployment using centralized governance.
o Enforce governance within your DevOps organization: Automate API governance using CLI commands in
your CI/CD pipeline.
Governance Console:
In the API Governance console, add governance rulesets to governance profiles to apply the
governance rulesets to multiple APIs across your organization. The API Governance console
then provides you with an overview of conformance for all validated APIs. Monitor your APIs'
conformance and notify developers to help improve the conformance.
1. View a numeric and visual summary of API Governance: Governance profile, Governance status,
Conformance status, and Nonconformance by severity.
2. View, filter and search a summary list of governance profiles or governed APIs.
3. Export conformance reports in CSV format.
4. Add new profile
5. View the comprehensive governance report for an API.
6. Select from the more options menu to take relevant actions. You can export reports for
a selected profile or API, view, edit, or delete a profile, notify API owners, or open an API
in Exchange.
Governance in Exchange, Design Center, and

API Manager
Exchange:
o Developers can view conformance status details for published API specifications,
discover rulesets, and publish custom rulesets.
o Implementors can view rulesets to determine how to fix API instance conformance
issues.
Design Center:
o Developers or architects can check API specification conformance in the API design phase by
applying governance rulesets directly to API specifications as dependencies.
o Use the Project Errors section for information about where the issue is in the specification and
how to fix it.
1. Add rulesets to the API project.

2. View conformance issues and filter by level of severity.
3. Expand the project error section of the text editor to view
nonconformance messages.
o API Manager: Implementors can check API instance conformance by

viewing the comprehensive governance report.
1. View an overview of the rulesets against which the API is validated.
2. View the ruleset in Exchange.
3. Select a tab to view the conformance information for a specific API
aspect.
4. View the API in Exchange.
5. View the conformance details identified for a specific ruleset.
6. View the API code in Design Center
Anypoint API Governance Concepts:

Following are the concepts you need to know to use Anypoint API Governance.
Governance profiles
A governance profile applies selected governance rulesets to a filtered group of APIs.
API Governance then validates the APIs against the rulesets to determine governance
conformance.
Governance profile status

You can view profile statuses in the API Governance console. Governance profile
statuses are based on the percentage of conformant APIs in the profile:
o Normal: More than 70% of APIs are conformant.
o At Risk: Less than 70% of APIs are conformant.
Governance rulesets
Governance rulesets are collections of rules, or guidelines, that can be applied over the
metadata extracted from APIs in Any point Platform. Some examples of governance
rulesets are internal and external best practice guidelines, such as naming conventions,
and industry-specific government standards, such as making sure your APIs that have
sensitive data are encrypted (HTTPS).
MuleSoft provides several rulesets in Exchange, such as Anypoint API Best Practices,
OpenAPI Best Practices, OWASP API Security Top 10, and Authentication Security Best
Practices governance rulesets. You can discover rulesets published in Exchange by
filtering the search in Exchange by the Rulesets type. See Search for Assets.
Governed APIs
APIs are governed if they are identified by the selection criteria of at least one of the governance profiles.
If an API is governed, all versions of that API are considered one governed API. Subscription limits are set
based on your organization’s purchased capacity and the UI gives information about usage and alerts
when you are nearing or exceeding your subscription capacity.
governance status
Governance status in the API Governance console shows the number of governed APIs, total number of
APIs of supported API types, and subscription limit information.
API conformance
API conformance indicates whether a validated API specification passes all of the required rules in one or
more governance rulesets. If an API specification is included in multiple governance profiles, it must pass
all of the rulesets in all of those profiles to be conformant.
API conformance status

API conformance status indicates whether the APIs that are included in your governance profiles pass all
applied governance rulesets:
o Conformant: The APIs pass all applied governance rulesets.

o Not Conformant: The APIs fail at least one governance ruleset.
o Not Validated: The APIs are not validated because they are not included in a governance
profile.
Versions of an API might have different conformance statuses. Total version conformance
status counts are shown in the API Governance console and conformance status indicators
are shown for API versions in API Governance, Exchange, and API Manager.
API conformance applies only to API types supported by API Governance, such as REST API
and AsyncAPI.
nonconformance severity
Nonconformance severity is categorized by percentage of passed rulesets among all required rulesets.
o High Severity: 0 - 40% rulesets passed

o Medium Severity: 41% - 80% rulesets passed
o Low Severity: 81% - 99% rulesets passed
project errors
Project errors are shown in the Design Center API Designer text editor page. The Project Errors section of
the page shows functional issues and nonconformance messages found in the API specification that is
open in the text editor.
API Governance usage reports

You can view usage reports to gain insight into your monthly usage of API Governance. See Viewing Usage
Reports for API Governance.
API
The entire API, including all its aspects. In Anypoint Platform, aspects of an API might also be called just
API in context with the product that is managing them. For example, in Exchange, API might refer to the
API specification, documentation, and catalog. In API Designer, API might refer to the API specification. In
API Catalog, API might refer to the API instance, policies, and contracts.
API aspects
Parts of an API. Examples of API aspects include specifications, instances, catalog information, and
documentation.
API specification
Details the functional and expected behavior of an API, as well as the fundamental design philosophy and
supported data types. It contains both documentation and API definitions to create a contract that people
and software can read.
API implementation
A realization of the API specification to make the API functional.
API instance
An instantiation of the API implementation. An API can have multiple instances across different
environments and gateways, which can be used by clients to make API calls. Instances that are configured
but not deployed are also captured as part of this aspect.
An instance can be either a proxy of an API that serves the upstream or an application endpoint.
API documentation
Helps consumers understand and use the API, with content such as examples, use cases, and tutorials.
API catalog information

Properties related to an API’s entry in an API catalog, such as name, version, owner (contact), tags and
categories.
In Anypoint Platform, these properties are tied to the API asset in Exchange.

API Governance

Uploaded by

Copyright:

Available Formats

API Governance

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API Governance

Uploaded by

Copyright:

Available Formats

Anypoint API Governance:

Anypoint API Governance is a component of Anypoint

Governance in Exchange, Design Center, and

1. Add rulesets to the API project.

o API Manager: Implementors can check API instance conformance by

Anypoint API Governance Concepts:

Governance profile status

API conformance status

o Conformant: The APIs pass all applied governance rulesets.

o High Severity: 0 - 40% rulesets passed

API Governance usage reports

API catalog information

You might also like