Skip to content

Add default rules for setting operation ID #55814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/OpenApi/src/Services/OpenApiDocumentService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Routing;
using Microsoft.AspNetCore.WebUtilities;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
Expand Down Expand Up @@ -140,6 +141,7 @@ private OpenApiOperation GetOperation(ApiDescription description, HashSet<OpenAp
}
var operation = new OpenApiOperation
{
OperationId = GetOperationId(description),
Summary = GetSummary(description),
Description = GetDescription(description),
Responses = GetResponses(description),
Expand All @@ -156,6 +158,10 @@ private OpenApiOperation GetOperation(ApiDescription description, HashSet<OpenAp
private static string? GetDescription(ApiDescription description)
=> description.ActionDescriptor.EndpointMetadata.OfType<IEndpointDescriptionMetadata>().LastOrDefault()?.Description;

private static string? GetOperationId(ApiDescription description)
=> description.ActionDescriptor.AttributeRouteInfo?.Name ??
description.ActionDescriptor.EndpointMetadata.OfType<IEndpointNameMetadata>().LastOrDefault()?.EndpointName;

private static List<OpenApiTag>? GetTags(ApiDescription description)
{
var actionDescriptor = description.ActionDescriptor;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Routing;
using Microsoft.OpenApi.Models;

public partial class OpenApiDocumentServiceTests
Expand Down Expand Up @@ -178,4 +180,58 @@ await VerifyOpenApiDocument(builder, document =>
});
});
}

[Fact]
public async Task GetOpenApiOperation_CapturesEndpointNameAsOperationId()
{
// Arrange
var builder = CreateBuilder();

// Act
builder.MapGet("/api/todos", () => { }).WithName("GetTodos");

// Assert
await VerifyOpenApiDocument(builder, document =>
{
var operation = document.Paths["/api/todos"].Operations[OperationType.Get];
Assert.Equal("GetTodos", operation.OperationId);

});
}

[Fact]
public async Task GetOpenApiOperation_CapturesEndpointNameAttributeAsOperationId()
{
// Arrange
var builder = CreateBuilder();

// Act
builder.MapGet("/api/todos", [EndpointName("GetTodos")] () => { });

// Assert
await VerifyOpenApiDocument(builder, document =>
{
var operation = document.Paths["/api/todos"].Operations[OperationType.Get];
Assert.Equal("GetTodos", operation.OperationId);

});
}

[Fact]
public async Task GetOpenApiOperation_CapturesRouteAttributeAsOperationId()
{
// Act
var action = CreateActionDescriptor(nameof(ActionWithRouteAttributeName));

// Assert
await VerifyOpenApiDocument(action, document =>
{
var operation = document.Paths["/api/todos"].Operations[OperationType.Get];
Assert.Equal("GetTodos", operation.OperationId);

});
}

[Route("/api/todos", Name = "GetTodos")]
private void ActionWithRouteAttributeName() { }
}
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,9 @@ public ControllerActionDescriptor CreateActionDescriptor(string methodName = nul

action.AttributeRouteInfo = new()
{
Template = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Template
Template = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Template,
Name = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Name,
Order = action.MethodInfo.GetCustomAttribute<RouteAttribute>()?.Order ?? 0,
};
action.RouteValues.Add("controller", "Test");
action.RouteValues.Add("action", action.MethodInfo.Name);
Expand Down
Loading