Repository navigation
Expand file tree
/
Copy pathAsyncApiReference.cs
More file actions
194 lines (163 loc) · 6.04 KB
/
Copy pathAsyncApiReference.cs
File metadata and controls
194 lines (163 loc) · 6.04 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
namespace ByteBard.AsyncAPI.Models
{
using System;
using System.Diagnostics;
using ByteBard.AsyncAPI.Exceptions;
using ByteBard.AsyncAPI.Models.Interfaces;
using ByteBard.AsyncAPI.Writers;
/// <summary>
/// A simple object to allow referencing other components in the specification, internally and externally.
/// </summary>
[DebuggerDisplay("{Reference}")]
public class AsyncApiReference : IAsyncApiSerializable, IEquatable<AsyncApiReference>
{
private string originalString;
public AsyncApiReference(string reference, ReferenceType? type)
{
if (string.IsNullOrWhiteSpace(reference))
{
throw new AsyncApiException($"The reference string '{reference}' has invalid format.");
}
this.originalString = reference;
var segments = reference.Split('#');
if (segments.Length == 1)
{
if (type == ReferenceType.SecurityScheme)
{
this.Type = ReferenceType.SecurityScheme;
this.FragmentId = reference;
return;
}
this.Type = type;
this.ExternalResource = segments[0];
return;
}
else if (segments.Length == 2)
{
if (reference.StartsWith("#")) // is local reference
{
var localSegments = reference.Split('/');
if (localSegments.Length == 4)
{
if (localSegments[1] == "components") // is local components reference
{
var referencedType = localSegments[2].GetEnumFromDisplayName<ReferenceType>();
if (type == null || type == ReferenceType.None)
{
type = referencedType;
}
else
{
if (type != referencedType)
{
throw new AsyncApiException("Referenced type mismatch");
}
}
}
}
}
else
{
this.ExternalResource = segments[0];
}
this.Type = type;
this.FragmentId = segments[1];
return;
}
throw new AsyncApiException($"The reference string '{reference}' has invalid format.");
}
/// <summary>
/// External resource in the reference.
/// It maybe:
/// 1. a absolute/relative file path, for example: ../commons/pet.json
/// 2. a Url, for example: http://localhost/pet.json.
/// </summary>
public string ExternalResource
{
get;
set;
}
/// <summary>
/// Gets or sets the element type referenced.
/// </summary>
public ReferenceType? Type { get; set; }
/// <summary>
/// Gets or sets the identifier of the reusable component of one particular ReferenceType.
/// </summary>
public string FragmentId { get; set; }
/// <summary>
/// Gets or sets the AsyncApiDocument that is hosting the AsyncApiReference instance. This is used to enable dereferencing the reference.
/// </summary>
public AsyncApiWorkspace Workspace { get; set; } = null;
/// <summary>
/// Gets a flag indicating whether a file is a valid OpenAPI document or a fragment.
/// </summary>
public bool IsFragment => this.FragmentId != null;
/// <summary>
/// Gets a flag indicating whether this reference is an external reference.
/// </summary>
public bool IsExternal => this.ExternalResource != null;
/// <summary>
/// Gets the full reference string;
/// </summary>
public string Reference
{
get
{
return this.originalString;
}
}
public static bool operator !=(AsyncApiReference left, AsyncApiReference right) => !(left == right);
public static bool operator ==(AsyncApiReference left, AsyncApiReference right)
{
return Equals(left, null) ? Equals(right, null) : left.Equals(right);
}
public bool Equals(AsyncApiReference reference)
{
if (reference == null)
{
return false;
}
return this.Reference == reference.Reference;
}
public override bool Equals(object obj)
{
if (obj is not AsyncApiReference reference)
{
return false;
}
return this.Equals(reference);
}
/// <summary>
/// Serialize <see cref="AsyncApiReference"/> to Async Api.
/// </summary>
public void SerializeV2(IAsyncApiWriter writer)
{
if (writer is null)
{
throw new ArgumentNullException(nameof(writer));
}
if (this.Type == ReferenceType.SecurityScheme)
{
// Write the string as property name
writer.WritePropertyName(this.Reference);
return;
}
writer.WriteStartObject();
// $ref
writer.WriteOptionalProperty(AsyncApiConstants.DollarRef, this.Reference);
writer.WriteEndObject();
}
public void SerializeV3(IAsyncApiWriter writer)
{
if (writer is null)
{
throw new ArgumentNullException(nameof(writer));
}
writer.WriteStartObject();
// $ref
writer.WriteOptionalProperty(AsyncApiConstants.DollarRef, this.Reference);
writer.WriteEndObject();
}
}
}