-
-
Notifications
You must be signed in to change notification settings - Fork 733
/
ApiResponse.cs
215 lines (186 loc) · 6.57 KB
/
ApiResponse.cs
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
using System.Diagnostics.CodeAnalysis;
using System.Net;
using System.Net.Http;
using System.Net.Http.Headers;
namespace Refit
{
static class ApiResponse
{
internal static T Create<T, TBody>(
HttpResponseMessage resp,
object? content,
RefitSettings settings,
ApiException? error = null
)
{
return (T)
Activator.CreateInstance(
typeof(ApiResponse<TBody>),
resp,
content,
settings,
error
)!;
}
}
/// <summary>
/// Implementation of <see cref="IApiResponse{T}"/> that provides additional functionalities.
/// </summary>
/// <typeparam name="T"></typeparam>
/// <remarks>
/// Create an instance of <see cref="ApiResponse{T}"/> with type <typeparamref name="T"/>.
/// </remarks>
/// <param name="response">Original HTTP Response message.</param>
/// <param name="content">Response content.</param>
/// <param name="settings">Refit settings used to send the request.</param>
/// <param name="error">The ApiException, if the request failed.</param>
/// <exception cref="ArgumentNullException"></exception>
public sealed class ApiResponse<T>(
HttpResponseMessage response,
T? content,
RefitSettings settings,
ApiException? error = null
) : IApiResponse<T>
{
readonly HttpResponseMessage response = response ?? throw new ArgumentNullException(nameof(response));
bool disposed;
/// <summary>
/// Deserialized request content as <typeparamref name="T"/>.
/// </summary>
public T? Content { get; } = content;
/// <summary>
/// Refit settings used to send the request.
/// </summary>
public RefitSettings Settings { get; } = settings;
/// <summary>
/// HTTP response headers.
/// </summary>
public HttpResponseHeaders Headers => response.Headers;
/// <summary>
/// HTTP response content headers as defined in RFC 2616.
/// </summary>
public HttpContentHeaders? ContentHeaders => response.Content?.Headers;
/// <summary>
/// Indicates whether the request was successful.
/// </summary>
#if NET6_0_OR_GREATER
[MemberNotNullWhen(true, nameof(Content))]
[MemberNotNullWhen(true, nameof(ContentHeaders))]
[MemberNotNullWhen(false, nameof(Error))]
#endif
public bool IsSuccessStatusCode => response.IsSuccessStatusCode;
/// <summary>
/// The reason phrase which typically is sent by the server together with the status code.
/// </summary>
public string? ReasonPhrase => response.ReasonPhrase;
/// <summary>
/// The HTTP Request message which led to this response.
/// </summary>
public HttpRequestMessage? RequestMessage => response.RequestMessage;
/// <summary>
/// HTTP response status code.
/// </summary>
public HttpStatusCode StatusCode => response.StatusCode;
/// <summary>
/// HTTP Message version.
/// </summary>
public Version Version => response.Version;
/// <summary>
/// The <see cref="ApiException" /> object in case of unsuccessful response.
/// </summary>
public ApiException? Error { get; private set; } = error;
/// <summary>
/// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
/// </summary>
public void Dispose()
{
Dispose(true);
}
/// <summary>
/// Ensures the request was successful by throwing an exception in case of failure
/// </summary>
/// <returns>The current <see cref="ApiResponse{T}"/></returns>
/// <exception cref="ApiException"></exception>
public async Task<ApiResponse<T>> EnsureSuccessStatusCodeAsync()
{
if (!IsSuccessStatusCode)
{
var exception =
Error
?? await ApiException
.Create(
response.RequestMessage!,
response.RequestMessage!.Method,
response,
Settings
)
.ConfigureAwait(false);
Dispose();
throw exception;
}
return this;
}
void Dispose(bool disposing)
{
if (!disposing || disposed)
return;
disposed = true;
response.Dispose();
}
}
/// <inheritdoc/>
public interface IApiResponse<out T> : IApiResponse
{
/// <summary>
/// Deserialized request content as <typeparamref name="T"/>.
/// </summary>
T? Content { get; }
}
/// <summary>
/// Base interface used to represent an API response.
/// </summary>
public interface IApiResponse : IDisposable
{
/// <summary>
/// HTTP response headers.
/// </summary>
HttpResponseHeaders Headers { get; }
/// <summary>
/// HTTP response content headers as defined in RFC 2616.
/// </summary>
HttpContentHeaders? ContentHeaders { get; }
/// <summary>
/// Indicates whether the request was successful.
/// </summary>
#if NET6_0_OR_GREATER
[MemberNotNullWhen(true, nameof(ContentHeaders))]
[MemberNotNullWhen(false, nameof(Error))]
#endif
bool IsSuccessStatusCode { get; }
/// <summary>
/// HTTP response status code.
/// </summary>
HttpStatusCode StatusCode { get; }
/// <summary>
/// The reason phrase which typically is sent by the server together with the status code.
/// </summary>
string? ReasonPhrase { get; }
/// <summary>
/// The HTTP Request message which led to this response.
/// </summary>
HttpRequestMessage? RequestMessage { get; }
/// <summary>
/// HTTP Message version.
/// </summary>
Version Version { get; }
/// <summary>
/// The <see cref="ApiException"/> object in case of unsuccessful response.
/// </summary>
[SuppressMessage(
"Naming",
"CA1716:Identifiers should not match keywords",
Justification = "By Design"
)]
ApiException? Error { get; }
}
}