-
Notifications
You must be signed in to change notification settings - Fork 244
Expand file tree
/
Copy pathApi.cs
More file actions
767 lines (637 loc) · 32 KB
/
Api.cs
File metadata and controls
767 lines (637 loc) · 32 KB
1
2
3
4
5
6
7
8
9
10
11
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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
285
286
287
288
289
290
291
292
293
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
using Azure;
using Azure.Core;
using Azure.Core.Pipeline;
using Flurl;
using LanguageExt;
using Polly;
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text.Json;
using System.Text.Json.Nodes;
using System.Text.Json.Serialization;
using System.Threading;
using System.Threading.Tasks;
using YamlDotNet.System.Text.Json;
namespace common;
public sealed record ApiRevisionNumber
{
private uint Value { get; }
private ApiRevisionNumber(uint value)
{
ArgumentOutOfRangeException.ThrowIfNegativeOrZero(value, nameof(value));
Value = value;
}
public int ToInt() => (int)Value;
public override string ToString() => string.Create(CultureInfo.InvariantCulture, $"{Value}");
public static ApiRevisionNumber From(int value) => new((uint)value);
public static Option<ApiRevisionNumber> TryFrom(string? value) =>
uint.TryParse(value, out var revisionNumber) && revisionNumber > 0
? new ApiRevisionNumber(revisionNumber)
: Option<ApiRevisionNumber>.None;
}
public sealed record ApiName : ResourceName, IResourceName<ApiName>
{
private const string RevisionSeparator = ";rev=";
private ApiName(string value) : base(value) { }
public static ApiName From(string value) => new(value);
private static Either<string, (ApiName RootName, ApiRevisionNumber RevisionNumber)> TryParseRevisionedName(string name) =>
name.Split(RevisionSeparator) switch
{
[var rootName, var revisionNumberString] =>
ApiRevisionNumber.TryFrom(revisionNumberString)
.Map(revisionNumber => (ApiName.From(rootName), revisionNumber))
.ToEither($"'{revisionNumberString}' is not a valid revision number."),
_ => $"Cannot parse name '{name}' as a revisioned API name."
};
public static Either<string, (ApiName RootName, ApiRevisionNumber RevisionNumber)> TryParseRevisionedName(ApiName name) =>
TryParseRevisionedName(name.Value);
public static bool IsNotRevisioned(ApiName name) => TryParseRevisionedName(name).IsLeft;
public static bool IsRevisioned(ApiName name) => TryParseRevisionedName(name).IsRight;
public static ApiName GetRootName(ApiName name) =>
TryParseRevisionedName(name).Map(revisionedName => revisionedName.RootName).IfLeft(name);
public static ApiName GetRevisionedName(ApiName name, ApiRevisionNumber revisionNumber)
{
var rootName = GetRootName(name);
return ApiName.From($"{rootName.Value}{RevisionSeparator}{revisionNumber.ToInt()}");
}
}
public sealed record ApisUri : ResourceUri
{
public required ManagementServiceUri ServiceUri { get; init; }
private static string PathSegment { get; } = "apis";
protected override Uri Value => ServiceUri.ToUri().AppendPathSegment(PathSegment).ToUri();
public static ApisUri From(ManagementServiceUri serviceUri) =>
new() { ServiceUri = serviceUri };
}
public sealed record ApiUri : ResourceUri
{
public required ApisUri Parent { get; init; }
public required ApiName Name { get; init; }
protected override Uri Value => Parent.ToUri().AppendPathSegment(Name.ToString()).ToUri();
public static ApiUri From(ApiName name, ManagementServiceUri serviceUri) =>
new()
{
Parent = ApisUri.From(serviceUri),
Name = name
};
}
public sealed record ApisDirectory : ResourceDirectory
{
public required ManagementServiceDirectory ServiceDirectory { get; init; }
private static string Name { get; } = "apis";
protected override DirectoryInfo Value =>
ServiceDirectory.ToDirectoryInfo().GetChildDirectory(Name);
public static ApisDirectory From(ManagementServiceDirectory serviceDirectory) =>
new() { ServiceDirectory = serviceDirectory };
public static Option<ApisDirectory> TryParse(DirectoryInfo? directory, ManagementServiceDirectory serviceDirectory) =>
directory is not null &&
directory.Name == Name &&
directory.Parent?.FullName == serviceDirectory.ToDirectoryInfo().FullName
? new ApisDirectory { ServiceDirectory = serviceDirectory }
: Option<ApisDirectory>.None;
}
public sealed record ApiDirectory : ResourceDirectory
{
public required ApisDirectory Parent { get; init; }
public required ApiName Name { get; init; }
protected override DirectoryInfo Value =>
Parent.ToDirectoryInfo().GetChildDirectory(Name.ToString());
public static ApiDirectory From(ApiName name, ManagementServiceDirectory serviceDirectory) =>
new()
{
Parent = ApisDirectory.From(serviceDirectory),
Name = name
};
public static Option<ApiDirectory> TryParse(DirectoryInfo? directory, ManagementServiceDirectory serviceDirectory) =>
from parent in ApisDirectory.TryParse(directory?.Parent, serviceDirectory)
select new ApiDirectory
{
Parent = parent,
Name = ApiName.From(directory!.Name)
};
}
public sealed record ApiInformationFile : ResourceFile
{
public required ApiDirectory Parent { get; init; }
private static string Name { get; } = "apiInformation.json";
protected override FileInfo Value =>
Parent.ToDirectoryInfo().GetChildFile(Name);
public static ApiInformationFile From(ApiName name, ManagementServiceDirectory serviceDirectory) =>
new()
{
Parent = new ApiDirectory
{
Parent = ApisDirectory.From(serviceDirectory),
Name = name
}
};
public static Option<ApiInformationFile> TryParse(FileInfo? file, ManagementServiceDirectory serviceDirectory) =>
file is not null && file.Name == Name
? from parent in ApiDirectory.TryParse(file.Directory, serviceDirectory)
select new ApiInformationFile { Parent = parent }
: Option<ApiInformationFile>.None;
}
public sealed record ApiDto
{
[JsonPropertyName("properties")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public required ApiCreateOrUpdateProperties Properties { get; init; }
public record ApiCreateOrUpdateProperties
{
[JsonPropertyName("path")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Path { get; init; }
[JsonPropertyName("apiRevision")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ApiRevision { get; init; }
[JsonPropertyName("apiRevisionDescription")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ApiRevisionDescription { get; init; }
[JsonPropertyName("apiVersion")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ApiVersion { get; init; }
[JsonPropertyName("apiVersionDescription")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ApiVersionDescription { get; init; }
[JsonPropertyName("apiVersionSetId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ApiVersionSetId { get; init; }
[JsonPropertyName("authenticationSettings")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public AuthenticationSettingsContract? AuthenticationSettings { get; init; }
[JsonPropertyName("contact")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ApiContactInformation? Contact { get; init; }
[JsonPropertyName("description")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Description { get; init; }
[JsonPropertyName("isCurrent")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? IsCurrent { get; init; }
[JsonPropertyName("license")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ApiLicenseInformation? License { get; init; }
[JsonPropertyName("apiType")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ApiType { get; init; }
[JsonPropertyName("apiVersionSet")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ApiVersionSetContractDetails? ApiVersionSet { get; init; }
[JsonPropertyName("displayName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DisplayName { get; init; }
[JsonPropertyName("format")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Format { get; init; }
[JsonPropertyName("protocols")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ImmutableArray<string>? Protocols { get; init; }
[JsonPropertyName("serviceUrl")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
#pragma warning disable CA1056 // URI-like properties should not be strings
public string? ServiceUrl { get; init; }
#pragma warning restore CA1056 // URI-like properties should not be strings
[JsonPropertyName("sourceApiId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? SourceApiId { get; init; }
[JsonPropertyName("translateRequiredQueryParameters")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? TranslateRequiredQueryParameters { get; init; }
[JsonPropertyName("value")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Value { get; init; }
[JsonPropertyName("wsdlSelector")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public WsdlSelectorContract? WsdlSelector { get; init; }
[JsonPropertyName("subscriptionKeyParameterNames")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public SubscriptionKeyParameterNamesContract? SubscriptionKeyParameterNames { get; init; }
[JsonPropertyName("subscriptionRequired")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? SubscriptionRequired { get; init; }
[JsonPropertyName("termsOfServiceUrl")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
#pragma warning disable CA1056 // URI-like properties should not be strings
public string? TermsOfServiceUrl { get; init; }
#pragma warning restore CA1056 // URI-like properties should not be strings
[JsonPropertyName("type")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Type { get; init; }
public record AuthenticationSettingsContract
{
[JsonPropertyName("oAuth2")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public OAuth2AuthenticationSettingsContract? OAuth2 { get; init; }
[JsonPropertyName("openid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public OpenIdAuthenticationSettingsContract? OpenId { get; init; }
}
public record OAuth2AuthenticationSettingsContract
{
[JsonPropertyName("authorizationServerId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? AuthorizationServerId { get; init; }
[JsonPropertyName("scope")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Scope { get; init; }
}
public record OpenIdAuthenticationSettingsContract
{
[JsonPropertyName("bearerTokenSendingMethods")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public ImmutableArray<string>? BearerTokenSendingMethods { get; init; }
[JsonPropertyName("openidProviderId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? OpenIdProviderId { get; init; }
}
public record ApiContactInformation
{
[JsonPropertyName("email")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Email { get; init; }
[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Name { get; init; }
[JsonPropertyName("url")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
#pragma warning disable CA1056 // URI-like properties should not be strings
public string? Url { get; init; }
#pragma warning restore CA1056 // URI-like properties should not be strings
}
public record ApiLicenseInformation
{
[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Name { get; init; }
[JsonPropertyName("url")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
#pragma warning disable CA1056 // URI-like properties should not be strings
public string? Url { get; init; }
#pragma warning restore CA1056 // URI-like properties should not be strings
}
public record ApiVersionSetContractDetails
{
[JsonPropertyName("description")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Description { get; init; }
[JsonPropertyName("id")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Id { get; init; }
[JsonPropertyName("name")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Name { get; init; }
[JsonPropertyName("versionHeaderName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? VersionHeaderName { get; init; }
[JsonPropertyName("versionQueryName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? VersionQueryName { get; init; }
[JsonPropertyName("versioningScheme")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? VersioningScheme { get; init; }
}
public record SubscriptionKeyParameterNamesContract
{
[JsonPropertyName("header")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Header { get; init; }
[JsonPropertyName("query")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Query { get; init; }
}
public record WsdlSelectorContract
{
[JsonPropertyName("wsdlEndpointName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? WsdlEndpointName { get; init; }
[JsonPropertyName("wsdlServiceName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? WsdlServiceName { get; init; }
}
}
}
public static class ApiModule
{
public static async ValueTask DeleteAll(this ApisUri uri, HttpPipeline pipeline, CancellationToken cancellationToken) =>
await uri.ListNames(pipeline, cancellationToken)
.GroupBy(ApiName.GetRootName)
.IterParallel(async group => await ApiUri.From(group.Key, uri.ServiceUri)
.DeleteAllRevisions(pipeline, cancellationToken),
cancellationToken);
public static IAsyncEnumerable<ApiName> ListNames(this ApisUri uri, HttpPipeline pipeline, CancellationToken cancellationToken) =>
pipeline.ListJsonObjects(uri.ToUri(), cancellationToken)
.Select(jsonObject => jsonObject.GetStringProperty("name"))
.Select(ApiName.From);
public static IAsyncEnumerable<(ApiName Name, ApiDto Dto)> List(this ApisUri apisUri, HttpPipeline pipeline, CancellationToken cancellationToken) =>
apisUri.ListNames(pipeline, cancellationToken)
.SelectAwait(async name =>
{
var uri = new ApiUri { Parent = apisUri, Name = name };
var dto = await uri.GetDto(pipeline, cancellationToken);
return (name, dto);
});
public static async ValueTask<Option<ApiDto>> TryGetDto(this ApiUri uri, HttpPipeline pipeline, CancellationToken cancellationToken)
{
var contentOption = await pipeline.GetContentOption(uri.ToUri(), cancellationToken);
return contentOption.Map(content => content.ToObjectFromJson<ApiDto>());
}
public static async ValueTask<ApiDto> GetDto(this ApiUri uri, HttpPipeline pipeline, CancellationToken cancellationToken)
{
var content = await pipeline.GetContent(uri.ToUri(), cancellationToken);
return content.ToObjectFromJson<ApiDto>();
}
public static async ValueTask<Option<BinaryData>> TryGetSpecificationContents(this ApiUri apiUri, ApiSpecification specification, HttpPipeline pipeline, CancellationToken cancellationToken)
{
if (specification is ApiSpecification.GraphQl)
{
return await apiUri.TryGetGraphQlSchema(pipeline, cancellationToken);
}
BinaryData? content;
try
{
var exportUri = GetExportUri(apiUri, specification, includeLink: true);
var downloadUri = await GetSpecificationDownloadUri(exportUri, pipeline, cancellationToken);
var nonAuthenticatedHttpPipeline = HttpPipelineBuilder.Build(ClientOptions.Default);
content = await nonAuthenticatedHttpPipeline.GetContent(downloadUri, cancellationToken);
}
// If we can't download the specification through the download link, get it directly.
catch (HttpRequestException exception) when (exception.StatusCode == HttpStatusCode.InternalServerError)
{
// Don't export XML specifications, as the non-link exports cannot be reimported.
if (specification is ApiSpecification.Wsdl or ApiSpecification.Wadl or ApiSpecification.OData)
{
return Option<BinaryData>.None;
}
var exportUri = GetExportUri(apiUri, specification, includeLink: false);
var json = await pipeline.GetJsonObject(exportUri, cancellationToken);
var contentString = json.GetProperty("value") switch
{
JsonValue jsonValue => jsonValue.ToString(),
var node => node.ToJsonString(JsonObjectExtensions.SerializerOptions)
};
content = BinaryData.FromString(contentString);
}
// APIM exports OpenApiV2 to JSON. Convert to YAML if needed.
if (specification is ApiSpecification.OpenApi openApi && openApi.Format is OpenApiFormat.Yaml && openApi.Version is OpenApiVersion.V2)
{
var yaml = YamlConverter.SerializeJson(content.ToString());
content = BinaryData.FromString(yaml);
}
return content;
}
private static Uri GetExportUri(ApiUri apiUri, ApiSpecification specification, bool includeLink)
{
var format = GetExportFormat(specification, includeLink);
return apiUri.ToUri()
.SetQueryParam("format", format)
.SetQueryParam("export", "true")
.SetQueryParam("api-version", "2022-09-01-preview")
.ToUri();
}
private static string GetExportFormat(ApiSpecification specification, bool includeLink)
{
var formatWithoutLink = specification switch
{
ApiSpecification.Wadl => "wadl",
ApiSpecification.Wsdl => "wsdl",
ApiSpecification.OData => "odata",
ApiSpecification.OpenApi openApiSpecification =>
(openApiSpecification.Version, openApiSpecification.Format) switch
{
(OpenApiVersion.V2, _) => "swagger",
(OpenApiVersion.V3, OpenApiFormat.Yaml) => "openapi",
(OpenApiVersion.V3, OpenApiFormat.Json) => "openapi+json",
_ => throw new NotSupportedException()
},
_ => throw new NotSupportedException()
};
return includeLink ? $"{formatWithoutLink}-link" : formatWithoutLink;
}
private static async ValueTask<Uri> GetSpecificationDownloadUri(Uri exportUri, HttpPipeline pipeline, CancellationToken cancellationToken)
{
var json = await pipeline.GetJsonObject(exportUri, cancellationToken);
return json.GetJsonObjectProperty("value")
.GetAbsoluteUriProperty("link");
}
public static async ValueTask Delete(this ApiUri uri, HttpPipeline pipeline, CancellationToken cancellationToken) =>
await pipeline.DeleteResource(uri.ToUri(), waitForCompletion: true, cancellationToken);
public static async ValueTask DeleteAllRevisions(this ApiUri uri, HttpPipeline pipeline, CancellationToken cancellationToken) =>
await pipeline.DeleteResource(uri.ToUri()
.SetQueryParam("deleteRevisions", "true")
.ToUri(), waitForCompletion: true, cancellationToken);
public static async ValueTask PutDto(this ApiUri uri, ApiDto dto, HttpPipeline pipeline, CancellationToken cancellationToken)
{
if (dto.Properties.Format is null && dto.Properties.Value is null)
{
var content = BinaryData.FromObjectAsJson(dto);
await pipeline.PutContent(uri.ToUri(), content, cancellationToken);
}
else
{
if (dto.Properties.Type is "soap")
{
await PutSoapApi(uri, dto, pipeline, cancellationToken);
}
else if (dto.Properties.ApiType is "odata")
{
await PutODataApi(uri, dto, pipeline, cancellationToken);
}
else
{
await PutNonSoapApi(uri, dto, pipeline, cancellationToken);
}
}
using var _ =
await new ResiliencePipelineBuilder<Response>()
.AddRetry(new()
{
BackoffType = DelayBackoffType.Exponential,
UseJitter = true,
MaxRetryAttempts = 5,
ShouldHandle = new PredicateBuilder<Response>().HandleResult(CreationInProgress)
})
.Build()
.ExecuteAsync(async cancellationToken =>
{
using var request = pipeline.CreateRequest(uri.ToUri(), RequestMethod.Get);
return await pipeline.SendRequestAsync(request, cancellationToken);
}, cancellationToken);
}
private static async ValueTask PutSoapApi(ApiUri uri, ApiDto dto, HttpPipeline pipeline, CancellationToken cancellationToken)
{
// Import API with specification
var soapUri = uri.ToUri().SetQueryParam("import", "true").ToUri();
var soapDto = new ApiDto
{
Properties = new ApiDto.ApiCreateOrUpdateProperties
{
Format = "wsdl",
Value = dto.Properties.Value,
ApiType = "soap",
DisplayName = dto.Properties.DisplayName,
Path = dto.Properties.Path,
Protocols = dto.Properties.Protocols,
ApiVersion = dto.Properties.ApiVersion,
ApiVersionDescription = dto.Properties.ApiVersionDescription,
ApiVersionSetId = dto.Properties.ApiVersionSetId
}
};
await pipeline.PutContent(soapUri, BinaryData.FromObjectAsJson(soapDto), cancellationToken);
// Put API again without specification
var updatedDto = dto with { Properties = dto.Properties with { Format = null, Value = null } };
// SOAP apis sometimes fail on put; retry if needed
await soapApiResiliencePipeline.Value
.ExecuteAsync(async cancellationToken => await pipeline.PutContent(uri.ToUri(), BinaryData.FromObjectAsJson(updatedDto), cancellationToken), cancellationToken);
}
private static readonly Lazy<ResiliencePipeline> soapApiResiliencePipeline = new(() =>
new ResiliencePipelineBuilder()
.AddRetry(new()
{
BackoffType = DelayBackoffType.Exponential,
UseJitter = true,
MaxRetryAttempts = 3,
ShouldHandle = new PredicateBuilder().Handle<HttpRequestException>(exception => exception.StatusCode == HttpStatusCode.Conflict && exception.Message.Contains("IdentifierAlreadyInUse", StringComparison.OrdinalIgnoreCase))
})
.Build());
private static async ValueTask PutODataApi(ApiUri uri, ApiDto dto, HttpPipeline pipeline, CancellationToken cancellationToken)
{
// Import API with specification
var odataUri = uri.ToUri().SetQueryParam("import", "true").ToUri();
var odataDto = new ApiDto
{
Properties = new ApiDto.ApiCreateOrUpdateProperties
{
Format = "odata",
Value = dto.Properties.Value,
ApiType = "odata",
DisplayName = dto.Properties.DisplayName,
Path = dto.Properties.Path,
Protocols = dto.Properties.Protocols,
ApiVersion = dto.Properties.ApiVersion,
ApiVersionDescription = dto.Properties.ApiVersionDescription,
ApiVersionSetId = dto.Properties.ApiVersionSetId
}
};
await pipeline.PutContent(odataUri, BinaryData.FromObjectAsJson(odataDto), cancellationToken);
// Put API again without specification
var updatedDto = dto with { Properties = dto.Properties with { Format = null, Value = null } };
await pipeline.PutContent(uri.ToUri(), BinaryData.FromObjectAsJson(updatedDto), cancellationToken);
}
private static async ValueTask PutNonSoapApi(ApiUri uri, ApiDto dto, HttpPipeline pipeline, CancellationToken cancellationToken)
{
// Put API without the specification.
var modelWithoutSpecification = dto with
{
Properties = dto.Properties with
{
Format = null,
Value = null,
ServiceUrl = null,
Type = dto.Properties.Type,
ApiType = dto.Properties.ApiType
}
};
await pipeline.PutContent(uri.ToUri(), BinaryData.FromObjectAsJson(modelWithoutSpecification), cancellationToken);
// Put API again with specification
await pipeline.PutContent(uri.ToUri(), BinaryData.FromObjectAsJson(dto), cancellationToken);
}
private static bool CreationInProgress(Response response)
{
if (response.Status != (int)HttpStatusCode.Created)
{
return false;
}
if (response.Headers.Any(header => header.Name.Equals("Content-Type", StringComparison.OrdinalIgnoreCase)
&& header.Value.Contains("application/json", StringComparison.OrdinalIgnoreCase)) is false)
{
return false;
}
try
{
return response.Content.ToObjectFromJson<JsonObject>()
.TryGetJsonObjectProperty("properties")
.Bind(json => json.TryGetStringProperty("ProvisioningState"))
.ToOption()
.Where(state => state.Equals("InProgress", StringComparison.OrdinalIgnoreCase))
.IsSome;
}
catch (JsonException)
{
return false;
}
}
public static async ValueTask PutGraphQlSchema(this ApiUri uri, BinaryData schema, HttpPipeline pipeline, CancellationToken cancellationToken)
{
var contents = BinaryData.FromObjectAsJson(new JsonObject()
{
["properties"] = new JsonObject
{
["contentType"] = "application/vnd.ms-azure-apim.graphql.schema",
["document"] = new JsonObject()
{
["value"] = schema.ToString()
}
}
});
await pipeline.PutContent(uri.ToUri()
.AppendPathSegment("schemas")
.AppendPathSegment("graphql")
.ToUri(), contents, cancellationToken);
}
public static async ValueTask<Option<BinaryData>> TryGetGraphQlSchema(this ApiUri uri, HttpPipeline pipeline, CancellationToken cancellationToken)
{
var schemaUri = uri.ToUri()
.AppendPathSegment("schemas")
.AppendPathSegment("graphql")
.ToUri();
var schemaJsonOption = await pipeline.GetJsonObjectOption(schemaUri, cancellationToken);
return schemaJsonOption.Map(GetGraphQlSpecificationFromSchemaResponse);
}
private static BinaryData GetGraphQlSpecificationFromSchemaResponse(JsonObject responseJson)
{
var schema = responseJson.GetJsonObjectProperty("properties")
.GetJsonObjectProperty("document")
.GetNonEmptyOrWhiteSpaceStringProperty("value");
return BinaryData.FromString(schema);
}
public static IEnumerable<ApiDirectory> ListDirectories(ManagementServiceDirectory serviceDirectory)
{
var apisDirectory = ApisDirectory.From(serviceDirectory);
return apisDirectory.ToDirectoryInfo()
.ListDirectories("*")
.Select(directoryInfo => ApiName.From(directoryInfo.Name))
.Select(name => new ApiDirectory { Parent = apisDirectory, Name = name });
}
public static IEnumerable<ApiInformationFile> ListInformationFiles(ManagementServiceDirectory serviceDirectory) =>
ListDirectories(serviceDirectory)
.Select(directory => new ApiInformationFile { Parent = directory })
.Where(informationFile => informationFile.ToFileInfo().Exists());
public static IAsyncEnumerable<ApiSpecificationFile> ListSpecificationFiles(ManagementServiceDirectory serviceDirectory) =>
ListDirectories(serviceDirectory)
.SelectMany(directory => directory.ToDirectoryInfo().ListFiles("*"))
.ToAsyncEnumerable()
.Choose(async (file, cancellationToken) => await ApiSpecificationFile.TryParse(file, serviceDirectory, cancellationToken));
public static async ValueTask WriteDto(this ApiInformationFile file, ApiDto dto, CancellationToken cancellationToken)
{
var content = BinaryData.FromObjectAsJson(dto, JsonObjectExtensions.SerializerOptions);
await file.ToFileInfo().OverwriteWithBinaryData(content, cancellationToken);
}
public static async ValueTask<ApiDto> ReadDto(this ApiInformationFile file, CancellationToken cancellationToken)
{
var content = await file.ToFileInfo().ReadAsBinaryData(cancellationToken);
return content.ToObjectFromJson<ApiDto>();
}
public static async ValueTask WriteSpecification(this ApiSpecificationFile file, BinaryData contents, CancellationToken cancellationToken) =>
await file.ToFileInfo().OverwriteWithBinaryData(contents, cancellationToken);
public static Option<VersionSetName> TryGetVersionSetName(ApiDto dto) =>
from versionSetId in Prelude.Optional(dto.Properties.ApiVersionSetId)
from versionSetNameString in versionSetId.Split('/')
.LastOrNone()
select VersionSetName.From(versionSetNameString);
}