You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/enable-managed-api-analysis-linting.md
+13-23Lines changed: 13 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Managed API linting and analysis - Azure API Center
3
3
description: Automatic linting of API definitions in your API center helps you analyze compliance of APIs with the organization's API style guide.
4
4
ms.service: azure-api-center
5
5
ms.topic: how-to
6
-
ms.date: 12/03/2024
6
+
ms.date: 03/31/2025
7
7
ms.author: danlep
8
8
author: dlepow
9
9
ms.custom:
@@ -18,17 +18,15 @@ With API analysis:
18
18
19
19
* Azure API Center automatically analyzes your API definitions whenever you add or update an API definition. API definitions are linted by default with a [spectral:oas ruleset](https://docs.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules) (API style guide).
20
20
* API analysis reports are generated in the Azure portal, showing how your API definitions conform to the style guide.
21
-
* You can use the Azure API Center extension for Visual Studio Code to customize and test your own API style guide locally and then deploy it to your API center.
22
-
21
+
* Use analysis profiles to specify the ruleset and filter conditions for the APIs that are analyzed. Customize a profile's ruleset using the Azure API Center extension for Visual Studio Code.
23
22
24
23
> [!IMPORTANT]
25
24
> If you prefer, you can enable [self-managed](enable-api-analysis-linting.md) linting and analysis using a custom Azure function, overriding the built-in capabilities. **Disable any function used for self-managed linting before using managed API analysis.**
26
25
27
26
## Limitations
28
27
29
28
* Currently, only OpenAPI and AsyncAPI specification documents in JSON or YAML format are analyzed.
30
-
* Currently, you configure a single ruleset, and it's applied to all OpenAPI definitions in your API center.
31
-
* There are [limits](../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#azure-api-center-limits) for the maximum number of API definitions analyzed. Analysis can take a few minutes to up to 24 hours to complete.
29
+
* There are [limits](../azure-resource-manager/management/azure-subscription-service-limits.md?toc=/azure/api-center/toc.json&bc=/azure/api-center/breadcrumb/toc.json#azure-api-center-limits) for the number of analysis profiles and the maximum number of API definitions analyzed. Analysis can take a few minutes to up to 24 hours to complete.
32
30
33
31
## Prerequisites
34
32
@@ -56,28 +54,15 @@ To view an analysis summary in your API center:
56
54
57
55
> [!TIP]
58
56
> You can also view the API analysis report by selecting **Analysis** from the API definition's menu bar.
59
-
<!--
60
-
## Customize ruleset
61
-
62
-
You can use the Azure API Center extension for Visual Studio Code to customize the default ruleset for your API center or replace it as your organization's API style guide. For example, you can [extend the ruleset](https://docs.stoplight.io/docs/spectral/83527ef2dd8c0-extending-rulesets) or add [custom functions](https://docs.stoplight.io/docs/spectral/a781e290eb9f9-custom-functions).
63
-
64
-
To customize or replace the ruleset:
65
-
66
-
1. In Visual Studio Code, select the Azure API Center icon from the Activity Bar.
67
-
1. Open the `.api-center-rules` folder at the root of your working folder.
68
-
1. In the folder for your API center resource, open the `ruleset.yaml` file.
69
-
1. Modify or replace the content as needed.
70
-
1. Save your changes to `ruleset.yaml`.
71
-
-->
72
57
73
-
## Analysis profiles
58
+
## Manage analysis profiles
74
59
75
-
Azure API Center uses *analysis profiles* for linting and analyzing APIs. An analysis profile specifies a ruleset and optionally filter conditions for APIs that are analyzed. A default profile applies the `spectral:oas` ruleset to all OpenAPI and AsyncAPI definitions.
60
+
Azure API Center uses *analysis profiles* for linting and analyzing APIs. An analysis profile specifies a ruleset and optionally filter conditions for APIs that are analyzed. The default analysis profile applies the `spectral:oas` ruleset to all OpenAPI and AsyncAPI definitions.
76
61
77
62
You can customize the ruleset and define filter conditions in the default profile, or you can create a new profile. For example, you might want to use one profile for APIs that are in development and a different one for APIs that are in production.
78
63
79
64
> [!NOTE]
80
-
> In the Standard plan of API Center, you can create up to 3 analysis profiles. Only a single default profile is supported in the Free plan.
65
+
> In the Standard plan of API Center, you can create up to 3 analysis profiles. Only a single profile is supported in the Free plan.
81
66
82
67
To create an analysis profile:
83
68
@@ -88,7 +73,12 @@ To create an analysis profile:
88
73
1. Under **Define filter conditions**, add one or more filter conditions for API definitions that the profile is applied to.
89
74
1. Select **Create**.
90
75
91
-
The profile is created and a ruleset scaffold is created.
76
+
77
+
:::image type="content" source="media/enable-managed-api-analysis-linting/create-analysis-profile.png" alt-text="Screenshot of creating an analysis profile in the portal.":::
78
+
79
+
The profile is created and a ruleset scaffold is created. To view the current ruleset, select the profile, and in the context (...) menu, select **View the ruleset**.
80
+
81
+
Continue to the following sections to customize the ruleset.
92
82
93
83
### Customize the profile's ruleset
94
84
@@ -108,7 +98,7 @@ Before deploying the custom ruleset to your API center, validate it locally. The
108
98
1. Type **Azure API Center: Set active API Style Guide** and hit **Enter**.
109
99
1. Choose **Select Local File** and specify the `ruleset.yaml` file that you customized. Hit **Enter**.
110
100
111
-
This step makes the custom ruleset the active API style guide for linting.
101
+
This step makes the custom ruleset the active API style guide for local linting.
112
102
113
103
Now, when you open an OpenAPI-based API definition file, a local linting operation is automatically triggered in Visual Studio Code. Results are displayed inline in the editor and in the **Problems** window (**View > Problems** or **Ctrl+Shift+M**).
0 commit comments