APImetrics measures API conformance with tools that allow you to evaluate your APIs. With our Conformance feature, we show you how conformant your APIs are with your chosen API standards and your OpenAPI specification documents, as well as their availability and performance. This ensures your APIs are secure for you and your customers and assesses whether your APIs are conformant or what needs to be improved.

To get to the Conformance section, select the Conformance option from the sidebar under Project Home.

Summary

Once configured, APImetrics runs regular conformance checks against your select Security Profile and your uploaded OAS documents. If you already have an OAS uploaded, you can select it for conformance checks on the Conformance Settings page. If you don't, you will be prompted on this page to upload. You can also upload an OAS file using the Files section in the sidebar or via the Inventory.

You can run conformance checks on demand any time by selecting the Evaluate Most Recent Results button at the bottom of the Summary page.

📘

To choose your desired Security Profile, go to Conformance Settings and there will be a dropdown with the available Security Profiles in APImetrics. Learn more about the different Security Profiles here.

At the top of the Summary page, four different boxes show whether your Project is passing or failing in the following four categories: Security, Schema, Availability, and Performance. Selecting the repeat button will then give you the percentage rate of the checks. This gives a quick summary of the current state of the Project.

Underneath, there is a table, each row detailing all the checkpoints in the Security Profile, all the Schemas, the Performance and the Availability. Each of these rows can be expanded for a brief explanation of what checks are happening and link to the Issue Details. For more information on all of the issues, you can view the Issue Details page.

Issue Details

The Issue Details tab will show all the issues that have been discovered by APImetrics, allowing for triaging with the Resolution Status and the creation of a remediation plan.

Settings

From the Settings tab, you will be able to change your Security Profile, update any of your SLO & SLA thresholds, or edit, delete, and add any new OpenAPI specifications.