如何让AutoRest按控制器拆分API's

本文关键字：API 拆分 控制器 AutoRest | 更新日期: 2023-09-27 18:11:48

现在我使用:

AutoRest'AutoRest.exe -Input %jsonUrl% -Namespace %projectName%ClientAutoGen -OutputDirectory %projectName%Client

生成我的ASP.NET Core Rest Client。

令人烦恼的是，AutoRest为该API中的所有controllers创建了单个file/class。我已经使用了pre-ASP.NET Core auto-generators，将每个controller拆分为自己的file/class，是否有任何方法强制AutoRest中的这种行为?

如何让AutoRest按控制器拆分API's

根据AutoRest团队在GitHub(这里:https://github.com/Azure/autorest/issues/1497)上的有用答案，答案是在OperationId中使用_，您希望分裂发生。这是我的Filter版本:

public class SwashbuckleOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        try
        {
            var pathSegments = context.ApiDescription.RelativePath.Split(new[] { '/' }).ToList();
            var version = string.Empty;
            var controller = string.Empty;
            if (pathSegments.Count > 1)
            {
                version = pathSegments[0];
                controller = pathSegments[1] + "_";
                pathSegments = pathSegments.Skip(2).Where(x => !x.Contains("{")).ToList();
            }
            string httpMethod = FirstCharToUpper(context.ApiDescription.HttpMethod);
            var routeName = context.ApiDescription.ActionDescriptor?.AttributeRouteInfo?.Name ?? string.Empty;
            operation.OperationId = $"{version}{controller}{httpMethod}{string.Join("", pathSegments)}{routeName}";
        }
        catch (Exception ex)
        {
            throw new Exception("Are you missing the [Route('"v1/[controller]/'")] on your Controller?", ex);
        }
    }
    private string FirstCharToUpper(string input)
    {
        if (String.IsNullOrEmpty(input))
            return string.Empty;
        input = input.Trim().ToLower();
        return input.First().ToString().ToUpper() + new string(input.Skip(1).ToArray());
    }
}

在StartUp:

中使用
services.AddSwaggerGen(options =>
{
    options.OperationFilter<SwashbuckleOperationFilter>();
    //...
}

像这样转动API Controller Method:

[Route("v1/[controller]/")]
public class ThingController : Controller
{
    [HttpGet("ById/{id}")]
    [Produces(typeof(ThingDTO))]
    public async Task<IActionResult> GetThing([FromRoute] long id)
    {
        // Your implementation
    }
}

进入这种生成的service method:

public class ThingClient : IThingClient
{
    private readonly AppSettings appSettings;
    private readonly IMapper mapper;
    private IV1Thing api;
    public ThingClient(IOptions<AppSettings> appSettingsOptions, IMapper mapper)
    {
        appSettings = appSettingsOptions.Value;
        this.mapper = mapper;
    }
    private IV1Thing service => api ??
                (api = new V1Thing(new ThingService(new Uri(appSettings.URLs.ThingService))));
    public async Task<IThing> GetByIdAsync(long thingId)
    {
        return mapper.Map<IThing>(await service.GetByIdAsync(thingId));
    }
}

这将与。net core 2.1一起工作，在我的控制器中我定义了一个SwaggerOperationAttribute。

    public class SwashbuckleOperationFilter : IOperationFilter
{
    public void Apply(Operation operation, OperationFilterContext context)
    {
        if (context.ApiDescription.ActionDescriptor is ControllerActionDescriptor controllerActionDescriptor)
        {
            operation.OperationId = $"{controllerActionDescriptor.ControllerName}_{operation.OperationId}";
        }
    }
}
相关文章：