更新
更旧
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Collections.Generic;
using System.Reflection;
using System.Security.Claims;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Abstractions;
using Microsoft.AspNetCore.Mvc.ModelBinding;
using Microsoft.AspNetCore.Routing;
using Microsoft.AspNetCore.Routing.Patterns;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.FileProviders;
using Microsoft.Extensions.Hosting;
using Xunit;
namespace Microsoft.AspNetCore.Mvc.ApiExplorer
{
public class EndpointMetadataApiDescriptionProviderTest
{
[Fact]
public void MultipleApiDescriptionsCreatedForMultipleHttpMethods()
{
var apiDescriptions = GetApiDescriptions(() => { }, "/", new string[] { "FOO", "BAR" });
Assert.Equal(2, apiDescriptions.Count);
}
[Fact]
public void ApiDescriptionNotCreatedIfNoHttpMethods()
{
var apiDescriptions = GetApiDescriptions(() => { }, "/", Array.Empty<string>());
Assert.Empty(apiDescriptions);
}
[Fact]
public void UsesDeclaringTypeAsControllerName()
{
var apiDescription = GetApiDescription(TestAction);
var declaringTypeName = typeof(EndpointMetadataApiDescriptionProviderTest).Name;
Assert.Equal(declaringTypeName, apiDescription.ActionDescriptor.RouteValues["controller"]);
}
[Fact]
public void UsesApplicationNameAsControllerNameIfNoDeclaringType()
{
var apiDescription = GetApiDescription(() => { });
Assert.Equal(nameof(EndpointMetadataApiDescriptionProviderTest), apiDescription.ActionDescriptor.RouteValues["controller"]);
}
[Fact]
public void AddsJsonRequestFormatWhenFromBodyInferred()
{
static void AssertJsonRequestFormat(ApiDescription apiDescription)
{
var requestFormat = Assert.Single(apiDescription.SupportedRequestFormats);
Assert.Equal("application/json", requestFormat.MediaType);
Assert.Null(requestFormat.Formatter);
}
AssertJsonRequestFormat(GetApiDescription(
(InferredJsonClass fromBody) => { }));
AssertJsonRequestFormat(GetApiDescription(
([FromBody] int fromBody) => { }));
}
[Fact]
public void AddsRequestFormatFromMetadata()
{
static void AssertCustomRequestFormat(ApiDescription apiDescription)
{
var requestFormat = Assert.Single(apiDescription.SupportedRequestFormats);
Assert.Equal("application/custom", requestFormat.MediaType);
Assert.Null(requestFormat.Formatter);
}
AssertCustomRequestFormat(GetApiDescription(
[Consumes("application/custom")]
(InferredJsonClass fromBody) =>
{ }));
AssertCustomRequestFormat(GetApiDescription(
[Consumes("application/custom")]
([FromBody] int fromBody) =>
{ }));
}
[Fact]
public void AddsMultipleRequestFormatsFromMetadata()
{
var apiDescription = GetApiDescription(
[Consumes("application/custom0", "application/custom1")]
(InferredJsonClass fromBody) =>
{ });
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
Assert.Equal(2, apiDescription.SupportedRequestFormats.Count);
var requestFormat0 = apiDescription.SupportedRequestFormats[0];
Assert.Equal("application/custom0", requestFormat0.MediaType);
Assert.Null(requestFormat0.Formatter);
var requestFormat1 = apiDescription.SupportedRequestFormats[1];
Assert.Equal("application/custom1", requestFormat1.MediaType);
Assert.Null(requestFormat1.Formatter);
}
[Fact]
public void AddsJsonResponseFormatWhenFromBodyInferred()
{
static void AssertJsonResponse(ApiDescription apiDescription, Type expectedType)
{
var responseType = Assert.Single(apiDescription.SupportedResponseTypes);
Assert.Equal(200, responseType.StatusCode);
Assert.Equal(expectedType, responseType.Type);
Assert.Equal(expectedType, responseType.ModelMetadata.ModelType);
var responseFormat = Assert.Single(responseType.ApiResponseFormats);
Assert.Equal("application/json", responseFormat.MediaType);
Assert.Null(responseFormat.Formatter);
}
AssertJsonResponse(GetApiDescription(() => new InferredJsonClass()), typeof(InferredJsonClass));
AssertJsonResponse(GetApiDescription(() => (IInferredJsonInterface)null), typeof(IInferredJsonInterface));
}
[Fact]
public void AddsTextResponseFormatWhenFromBodyInferred()
{
var apiDescription = GetApiDescription(() => "foo");
var responseType = Assert.Single(apiDescription.SupportedResponseTypes);
Assert.Equal(200, responseType.StatusCode);
Assert.Equal(typeof(string), responseType.Type);
Assert.Equal(typeof(string), responseType.ModelMetadata.ModelType);
var responseFormat = Assert.Single(responseType.ApiResponseFormats);
Assert.Equal("text/plain", responseFormat.MediaType);
Assert.Null(responseFormat.Formatter);
}
[Fact]
public void AddsNoResponseFormatWhenItCannotBeInferredAndTheresNoMetadata()
{
static void AssertVoid(ApiDescription apiDescription)
{
var responseType = Assert.Single(apiDescription.SupportedResponseTypes);
Assert.Equal(200, responseType.StatusCode);
Assert.Equal(typeof(void), responseType.Type);
Assert.Equal(typeof(void), responseType.ModelMetadata.ModelType);
Assert.Empty(responseType.ApiResponseFormats);
}
AssertVoid(GetApiDescription(() => { }));
AssertVoid(GetApiDescription(() => Task.CompletedTask));
AssertVoid(GetApiDescription(() => new ValueTask()));
}
[Fact]
public void AddsResponseFormatFromMetadata()
{
var apiDescription = GetApiDescription(
[ProducesResponseType(typeof(TimeSpan), StatusCodes.Status201Created)]
[Produces("application/custom")]
() => new InferredJsonClass());
var responseType = Assert.Single(apiDescription.SupportedResponseTypes);
Assert.Equal(201, responseType.StatusCode);
Assert.Equal(typeof(TimeSpan), responseType.Type);
Assert.Equal(typeof(TimeSpan), responseType.ModelMetadata.ModelType);
var responseFormat = Assert.Single(responseType.ApiResponseFormats);
Assert.Equal("application/custom", responseFormat.MediaType);
}
[Fact]
public void AddsMultipleResponseFormatsFromMetadataWithPoco()
{
var apiDescription = GetApiDescription(
[ProducesResponseType(typeof(TimeSpan), StatusCodes.Status201Created)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
() => new InferredJsonClass());
Assert.Equal(2, apiDescription.SupportedResponseTypes.Count);
var createdResponseType = apiDescription.SupportedResponseTypes[0];
Assert.Equal(201, createdResponseType.StatusCode);
Assert.Equal(typeof(TimeSpan), createdResponseType.Type);
Assert.Equal(typeof(TimeSpan), createdResponseType.ModelMetadata.ModelType);
var createdResponseFormat = Assert.Single(createdResponseType.ApiResponseFormats);
Assert.Equal("application/json", createdResponseFormat.MediaType);
var badRequestResponseType = apiDescription.SupportedResponseTypes[1];
Assert.Equal(400, badRequestResponseType.StatusCode);
Assert.Equal(typeof(InferredJsonClass), badRequestResponseType.Type);
Assert.Equal(typeof(InferredJsonClass), badRequestResponseType.ModelMetadata.ModelType);
var badRequestResponseFormat = Assert.Single(badRequestResponseType.ApiResponseFormats);
Assert.Equal("application/json", badRequestResponseFormat.MediaType);
}
[Fact]
public void AddsMultipleResponseFormatsFromMetadataWithIResult()
{
var apiDescription = GetApiDescription(
[ProducesResponseType(typeof(InferredJsonClass), StatusCodes.Status201Created)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
() => Results.Ok(new InferredJsonClass()));
Assert.Equal(2, apiDescription.SupportedResponseTypes.Count);
var createdResponseType = apiDescription.SupportedResponseTypes[0];
Assert.Equal(201, createdResponseType.StatusCode);
Assert.Equal(typeof(InferredJsonClass), createdResponseType.Type);
Assert.Equal(typeof(InferredJsonClass), createdResponseType.ModelMetadata.ModelType);
var createdResponseFormat = Assert.Single(createdResponseType.ApiResponseFormats);
Assert.Equal("application/json", createdResponseFormat.MediaType);
var badRequestResponseType = apiDescription.SupportedResponseTypes[1];
Assert.Equal(400, badRequestResponseType.StatusCode);
Assert.Equal(typeof(void), badRequestResponseType.Type);
Assert.Equal(typeof(void), badRequestResponseType.ModelMetadata.ModelType);
Assert.Empty(badRequestResponseType.ApiResponseFormats);
}
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
[Fact]
public void AddsFromRouteParameterAsPath()
{
static void AssertPathParameter(ApiDescription apiDescription)
{
var param = Assert.Single(apiDescription.ParameterDescriptions);
Assert.Equal(typeof(int), param.Type);
Assert.Equal(typeof(int), param.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Path, param.Source);
}
AssertPathParameter(GetApiDescription((int foo) => { }, "/{foo}"));
AssertPathParameter(GetApiDescription(([FromRoute] int foo) => { }));
}
[Fact]
public void AddsFromQueryParameterAsQuery()
{
static void AssertQueryParameter(ApiDescription apiDescription)
{
var param = Assert.Single(apiDescription.ParameterDescriptions);
Assert.Equal(typeof(int), param.Type);
Assert.Equal(typeof(int), param.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Query, param.Source);
}
AssertQueryParameter(GetApiDescription((int foo) => { }, "/"));
AssertQueryParameter(GetApiDescription(([FromQuery] int foo) => { }));
}
[Fact]
public void AddsFromHeaderParameterAsHeader()
{
var apiDescription = GetApiDescription(([FromHeader] int foo) => { });
var param = Assert.Single(apiDescription.ParameterDescriptions);
Assert.Equal(typeof(int), param.Type);
Assert.Equal(typeof(int), param.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Header, param.Source);
}
[Fact]
public void DoesNotAddFromServiceParameterAsService()
Assert.Empty(GetApiDescription((IInferredServiceInterface foo) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription(([FromServices] int foo) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((HttpContext context) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((HttpRequest request) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((HttpResponse response) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((ClaimsPrincipal user) => { }).ParameterDescriptions);
Assert.Empty(GetApiDescription((CancellationToken token) => { }).ParameterDescriptions);
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
}
[Fact]
public void AddsFromBodyParameterAsBody()
{
static void AssertBodyParameter(ApiDescription apiDescription, Type expectedType)
{
var param = Assert.Single(apiDescription.ParameterDescriptions);
Assert.Equal(expectedType, param.Type);
Assert.Equal(expectedType, param.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Body, param.Source);
}
AssertBodyParameter(GetApiDescription((InferredJsonClass foo) => { }), typeof(InferredJsonClass));
AssertBodyParameter(GetApiDescription(([FromBody] int foo) => { }), typeof(int));
}
[Fact]
public void AddsDefaultValueFromParameters()
{
var apiDescription = GetApiDescription(TestActionWithDefaultValue);
var param = Assert.Single(apiDescription.ParameterDescriptions);
Assert.Equal(42, param.DefaultValue);
}
[Fact]
public void AddsMultipleParameters()
{
var apiDescription = GetApiDescription(([FromRoute] int foo, int bar, InferredJsonClass fromBody) => { });
Assert.Equal(3, apiDescription.ParameterDescriptions.Count);
var fooParam = apiDescription.ParameterDescriptions[0];
Assert.Equal(typeof(int), fooParam.Type);
Assert.Equal(typeof(int), fooParam.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Path, fooParam.Source);
Assert.True(fooParam.IsRequired);
var barParam = apiDescription.ParameterDescriptions[1];
Assert.Equal(typeof(int), barParam.Type);
Assert.Equal(typeof(int), barParam.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Query, barParam.Source);
Assert.True(barParam.IsRequired);
var fromBodyParam = apiDescription.ParameterDescriptions[2];
Assert.Equal(typeof(InferredJsonClass), fromBodyParam.Type);
Assert.Equal(typeof(InferredJsonClass), fromBodyParam.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Body, fromBodyParam.Source);
Assert.True(fromBodyParam.IsRequired);
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
[Fact]
public void TestParameterIsRequired()
{
var apiDescription = GetApiDescription(([FromRoute] int foo, int? bar) => { });
Assert.Equal(2, apiDescription.ParameterDescriptions.Count);
var fooParam = apiDescription.ParameterDescriptions[0];
Assert.Equal(typeof(int), fooParam.Type);
Assert.Equal(typeof(int), fooParam.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Path, fooParam.Source);
Assert.True(fooParam.IsRequired);
var barParam = apiDescription.ParameterDescriptions[1];
Assert.Equal(typeof(int?), barParam.Type);
Assert.Equal(typeof(int?), barParam.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Query, barParam.Source);
Assert.False(barParam.IsRequired);
}
#nullable enable
[Fact]
public void TestIsRequiredFromBody()
{
var apiDescription0 = GetApiDescription(([FromBody(EmptyBodyBehavior = EmptyBodyBehavior.Allow)] InferredJsonClass fromBody) => { });
var apiDescription1 = GetApiDescription((InferredJsonClass? fromBody) => { });
Assert.Equal(1, apiDescription0.ParameterDescriptions.Count);
Assert.Equal(1, apiDescription1.ParameterDescriptions.Count);
var fromBodyParam0 = apiDescription0.ParameterDescriptions[0];
Assert.Equal(typeof(InferredJsonClass), fromBodyParam0.Type);
Assert.Equal(typeof(InferredJsonClass), fromBodyParam0.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Body, fromBodyParam0.Source);
Assert.False(fromBodyParam0.IsRequired);
var fromBodyParam1 = apiDescription1.ParameterDescriptions[0];
Assert.Equal(typeof(InferredJsonClass), fromBodyParam1.Type);
Assert.Equal(typeof(InferredJsonClass), fromBodyParam1.ModelMetadata.ModelType);
Assert.Equal(BindingSource.Body, fromBodyParam1.Source);
Assert.False(fromBodyParam1.IsRequired);
}
// This is necessary for TestIsRequiredFromBody to pass until https://github.com/dotnet/roslyn/issues/55254 is resolved.
private object RandomMethod() => throw new NotImplementedException();
#nullable disable
[Fact]
public void AddsDisplayNameFromRouteEndpoint()
{
var apiDescription = GetApiDescription(() => "foo", displayName: "FOO");
Assert.Equal("FOO", apiDescription.ActionDescriptor.DisplayName);
}
[Fact]
public void AddsMetadataFromRouteEndpoint()
{
var apiDescription = GetApiDescription([ApiExplorerSettings(IgnoreApi = true)]() => { });
Assert.NotEmpty(apiDescription.ActionDescriptor.EndpointMetadata);
var apiExplorerSettings = apiDescription.ActionDescriptor.EndpointMetadata
.OfType<ApiExplorerSettingsAttribute>()
.FirstOrDefault();
Assert.NotNull(apiExplorerSettings);
Assert.True(apiExplorerSettings.IgnoreApi);
}
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
[Fact]
public void RespectsProducesProblemExtensionMethod()
{
// Arrange
var builder = new TestEndpointRouteBuilder(new ApplicationBuilder(null));
builder.MapGet("/api/todos", () => "").ProducesProblem(StatusCodes.Status400BadRequest);
var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
var endpointDataSource = builder.DataSources.OfType<EndpointDataSource>().Single();
var hostEnvironment = new HostEnvironment
{
ApplicationName = nameof(EndpointMetadataApiDescriptionProviderTest)
};
var provider = new EndpointMetadataApiDescriptionProvider(endpointDataSource, hostEnvironment, new ServiceProviderIsService());
// Act
provider.OnProvidersExecuting(context);
// Assert
var apiDescription = Assert.Single(context.Results);
var responseTypes = Assert.Single(apiDescription.SupportedResponseTypes);
Assert.Equal(typeof(ProblemDetails), responseTypes.Type);
}
[Fact]
public void RespectsProducesWithGroupNameExtensionMethod()
{
// Arrange
var endpointGroupName = "SomeEndpointGroupName";
var builder = new TestEndpointRouteBuilder(new ApplicationBuilder(null));
builder.MapGet("/api/todos", () => "").Produces<InferredJsonClass>().WithGroupName(endpointGroupName);
var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
var endpointDataSource = builder.DataSources.OfType<EndpointDataSource>().Single();
var hostEnvironment = new HostEnvironment
{
ApplicationName = nameof(EndpointMetadataApiDescriptionProviderTest)
};
var provider = new EndpointMetadataApiDescriptionProvider(endpointDataSource, hostEnvironment, new ServiceProviderIsService());
// Act
provider.OnProvidersExecuting(context);
// Assert
var apiDescription = Assert.Single(context.Results);
var responseTypes = Assert.Single(apiDescription.SupportedResponseTypes);
Assert.Equal(typeof(InferredJsonClass), responseTypes.Type);
Assert.Equal(endpointGroupName, apiDescription.GroupName);
}
[Fact]
public void RespectsExcludeFromDescription()
{
// Arrange
var builder = new TestEndpointRouteBuilder(new ApplicationBuilder(null));
builder.MapGet("/api/todos", () => "").Produces<InferredJsonClass>().ExcludeFromDescription();
var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
var endpointDataSource = builder.DataSources.OfType<EndpointDataSource>().Single();
var hostEnvironment = new HostEnvironment
{
ApplicationName = nameof(EndpointMetadataApiDescriptionProviderTest)
};
var provider = new EndpointMetadataApiDescriptionProvider(endpointDataSource, hostEnvironment, new ServiceProviderIsService());
// Act
provider.OnProvidersExecuting(context);
// Assert
Assert.Empty(context.Results);
}
[Fact]
public void HandlesProducesWithProducesProblem()
{
// Arrange
var builder = new TestEndpointRouteBuilder(new ApplicationBuilder(null));
builder.MapGet("/api/todos", () => "")
.Produces<InferredJsonClass>(StatusCodes.Status200OK)
.ProducesValidationProblem()
.ProducesProblem(StatusCodes.Status404NotFound)
.ProducesProblem(StatusCodes.Status409Conflict);
var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
var endpointDataSource = builder.DataSources.OfType<EndpointDataSource>().Single();
var hostEnvironment = new HostEnvironment
{
ApplicationName = nameof(EndpointMetadataApiDescriptionProviderTest)
};
var provider = new EndpointMetadataApiDescriptionProvider(endpointDataSource, hostEnvironment, new ServiceProviderIsService());
// Act
provider.OnProvidersExecuting(context);
provider.OnProvidersExecuted(context);
// Assert
Assert.Collection(
context.Results.SelectMany(r => r.SupportedResponseTypes).OrderBy(r => r.StatusCode),
responseType =>
{
Assert.Equal(typeof(InferredJsonClass), responseType.Type);
Assert.Equal(200, responseType.StatusCode);
Assert.Equal(new[] { "application/json" }, GetSortedMediaTypes(responseType));
},
responseType =>
{
Assert.Equal(typeof(HttpValidationProblemDetails), responseType.Type);
Assert.Equal(400, responseType.StatusCode);
Assert.Equal(new[] { "application/validationproblem+json" }, GetSortedMediaTypes(responseType));
},
responseType =>
{
Assert.Equal(typeof(ProblemDetails), responseType.Type);
Assert.Equal(404, responseType.StatusCode);
Assert.Equal(new[] { "application/problem+json" }, GetSortedMediaTypes(responseType));
},
responseType =>
{
Assert.Equal(typeof(ProblemDetails), responseType.Type);
Assert.Equal(409, responseType.StatusCode);
Assert.Equal(new[] { "application/problem+json" }, GetSortedMediaTypes(responseType));
});
}
[Fact]
public void HandleMultipleProduces()
{
// Arrange
var builder = new TestEndpointRouteBuilder(new ApplicationBuilder(null));
builder.MapGet("/api/todos", () => "")
.Produces<InferredJsonClass>(StatusCodes.Status200OK)
.Produces<InferredJsonClass>(StatusCodes.Status201Created);
var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
var endpointDataSource = builder.DataSources.OfType<EndpointDataSource>().Single();
var hostEnvironment = new HostEnvironment
{
ApplicationName = nameof(EndpointMetadataApiDescriptionProviderTest)
};
var provider = new EndpointMetadataApiDescriptionProvider(endpointDataSource, hostEnvironment, new ServiceProviderIsService());
// Act
provider.OnProvidersExecuting(context);
provider.OnProvidersExecuted(context);
// Assert
Assert.Collection(
context.Results.SelectMany(r => r.SupportedResponseTypes).OrderBy(r => r.StatusCode),
responseType =>
{
Assert.Equal(typeof(InferredJsonClass), responseType.Type);
Assert.Equal(200, responseType.StatusCode);
Assert.Equal(new[] { "application/json" }, GetSortedMediaTypes(responseType));
},
responseType =>
{
Assert.Equal(typeof(InferredJsonClass), responseType.Type);
Assert.Equal(201, responseType.StatusCode);
Assert.Equal(new[] { "application/json" }, GetSortedMediaTypes(responseType));
});
}
private static IEnumerable<string> GetSortedMediaTypes(ApiResponseType apiResponseType)
{
return apiResponseType.ApiResponseFormats
.OrderBy(format => format.MediaType)
.Select(format => format.MediaType);
}
private IList<ApiDescription> GetApiDescriptions(
Delegate action,
string pattern = null,
IEnumerable<string> httpMethods = null,
string displayName = null)
{
var methodInfo = action.Method;
var attributes = methodInfo.GetCustomAttributes();
var context = new ApiDescriptionProviderContext(Array.Empty<ActionDescriptor>());
var httpMethodMetadata = new HttpMethodMetadata(httpMethods ?? new[] { "GET" });
var metadataItems = new List<object>(attributes) { methodInfo, httpMethodMetadata };
var endpointMetadata = new EndpointMetadataCollection(metadataItems.ToArray());
var routePattern = RoutePatternFactory.Parse(pattern ?? "/");
var endpoint = new RouteEndpoint(httpContext => Task.CompletedTask, routePattern, 0, endpointMetadata, displayName);
var endpointDataSource = new DefaultEndpointDataSource(endpoint);
var hostEnvironment = new HostEnvironment
{
ApplicationName = nameof(EndpointMetadataApiDescriptionProviderTest)
};
var provider = new EndpointMetadataApiDescriptionProvider(endpointDataSource, hostEnvironment, new ServiceProviderIsService());
provider.OnProvidersExecuting(context);
provider.OnProvidersExecuted(context);
return context.Results;
}
private ApiDescription GetApiDescription(Delegate action, string pattern = null, string displayName = null) =>
Assert.Single(GetApiDescriptions(action, pattern, displayName: displayName));
private static void TestAction()
{
}
private static void TestActionWithDefaultValue(int foo = 42)
{
}
private class InferredJsonClass
{
}
private interface IInferredServiceInterface
{
}
private interface IInferredJsonInterface
{
}
private class ServiceProviderIsService : IServiceProviderIsService
{
public bool IsService(Type serviceType) => serviceType == typeof(IInferredServiceInterface);
}
private class HostEnvironment : IHostEnvironment
{
public string EnvironmentName { get; set; }
public string ApplicationName { get; set; }
public string ContentRootPath { get; set; }
public IFileProvider ContentRootFileProvider { get; set; }
}
private class TestEndpointRouteBuilder : IEndpointRouteBuilder
{
public TestEndpointRouteBuilder(IApplicationBuilder applicationBuilder)
{
ApplicationBuilder = applicationBuilder ?? throw new ArgumentNullException(nameof(applicationBuilder));
DataSources = new List<EndpointDataSource>();
}
public IApplicationBuilder ApplicationBuilder { get; }
public IApplicationBuilder CreateApplicationBuilder() => ApplicationBuilder.New();
public ICollection<EndpointDataSource> DataSources { get; }
public IServiceProvider ServiceProvider => ApplicationBuilder.ApplicationServices;
}