policy-compilation

name	policy-compilation
description	Conventions and patterns for creating policy compilers in the Azure API Management policy toolkit. Use this skill when creating or modifying compiler classes in src/Core/Compiling/Policy/.

Policy Compilation Patterns

This skill describes how to implement compilers that convert authoring models to XML in the Azure API Management policy toolkit.

Compiler Class — src/Core/Compiling/Policy/{PolicyName}Compiler.cs

Config-Based Compiler Template (Most Common)

Use this for policies that take a config object parameter.

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System.Xml.Linq;

using Microsoft.Azure.ApiManagement.PolicyToolkit.Authoring;
using Microsoft.Azure.ApiManagement.PolicyToolkit.Compiling.Diagnostics;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp.Syntax;

namespace Microsoft.Azure.ApiManagement.PolicyToolkit.Compiling.Policy;

public class {PolicyName}Compiler : IMethodPolicyHandler
{
    public string MethodName => nameof(I{Section}Context.{MethodName});

    public void Handle(IDocumentCompilationContext context, InvocationExpressionSyntax node)
    {
        if (!node.TryExtractingConfigParameter<{PolicyName}Config>(context, ,   values))
        {
            ;
        }

         element =  XElement();

        
         (!element.AddAttribute(values, ({PolicyName}Config.{RequiredProp}), ))
        {
            context.Report(Diagnostic.Create(
                CompilationErrors.RequiredParameterNotDefined,
                node.GetLocation(),
                ,
                ({PolicyName}Config.{RequiredProp})
            ));
            ;
        }

        
        element.AddAttribute(values, ({PolicyName}Config.{OptionalProp}), );

        
        

        context.AddPolicy(element);
    }
}