-
Notifications
You must be signed in to change notification settings - Fork 0
/
Startup.cs
224 lines (204 loc) · 8.64 KB
/
Startup.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
216
217
218
219
220
221
222
223
224
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using AutoMapper;
using Microsoft.AspNet.OData.Builder;
using Microsoft.AspNet.OData.Extensions;
using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using Microsoft.Extensions.PlatformAbstractions;
using Microsoft.OData;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
namespace ODataTest
{
/// <summary>
/// Represents the startup process for the application.
/// </summary>
public class Startup
{
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public IConfiguration Configuration { get; }
// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
ConfigureMisc(services);
ConfigureCors(services);
ConfigureOData(services);
ApiSecurityOptions apiSecurityOptions = ReadApiSecurityOptions();
ConfigureSwagger(services, apiSecurityOptions);
ConfigureAuth(services, apiSecurityOptions);
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(
IApplicationBuilder app,
VersionedODataModelBuilder modelBuilder,
IApiVersionDescriptionProvider provider)
{
app.UseRouting();
app.UseCors();
app.UseHttpsRedirection();
app.UseAuthentication();
app.UseAuthorization();
app.UseEndpoints(
endpoints =>
{
// global odata query options
endpoints.Count();
// the following will not work as expected
// BUG: https://github.com/OData/WebApi/issues/1837
// endpoints.SetDefaultODataOptions(
// new ODataOptions() { UrlKeyDelimiter = Parentheses } );
// endpoints
// .ServiceProvider
// .GetRequiredService<ODataOptions>()
// .UrlKeyDelimiter = ODataUrlKeyDelimiter.Parentheses;
// register routes with and without the api version constraint
endpoints.MapVersionedODataRoute(
"explicit",
"api/v{version:apiVersion}",
modelBuilder);
endpoints.MapVersionedODataRoute("odata", "api", modelBuilder);
});
ConfigureSwaggerUI(app, provider);
}
private ApiSecurityOptions ReadApiSecurityOptions()
{
IConfigurationSection options = Configuration.GetSection(ApiSecurityOptions.OptionsName);
return new ApiSecurityOptions
{
Audience = options.GetValue<string>(nameof(ApiSecurityOptions.Audience)),
Authority = options.GetValue<string>(nameof(ApiSecurityOptions.Authority))
};
}
private void ConfigureMisc(IServiceCollection services)
{
services
.AddMvc(options => options.EnableEndpointRouting = false)
.SetCompatibilityVersion(CompatibilityVersion.Latest);
services.Configure<ApiSecurityOptions>(Configuration.GetSection(ApiSecurityOptions.OptionsName));
services.AddAutoMapper(typeof(MappingProfile));
services.AddApiVersioning(options => options.ReportApiVersions = true);
}
private void ConfigureSwaggerUI(
IApplicationBuilder app,
IApiVersionDescriptionProvider provider)
{
app.UseSwagger();
app.UseSwaggerUI(
options =>
{
options.OAuthClientId(Configuration.GetValue<string>("ClientId"));
options.OAuthAppName("OData Test Api Swagger");
options.OAuthUsePkce();
// build a swagger endpoint for each discovered API version
foreach (var description in provider.ApiVersionDescriptions)
{
options.SwaggerEndpoint(
$"/swagger/{description.GroupName}/swagger.json",
description.GroupName.ToUpperInvariant());
}
});
}
private static void ConfigureCors(IServiceCollection services)
{
services.AddCors(options =>
{
options.AddDefaultPolicy(
builder =>
{
builder.WithOrigins(
"http://localhost:*",
"https://localhost:*");
});
});
}
private static void ConfigureOData(IServiceCollection services)
{
services.AddOData().EnableApiVersioning();
services.AddODataApiExplorer(
options =>
{
// add the versioned api explorer, which also adds IApiVersionDescriptionProvider service
// note: the specified format code will format the version as "'v'major[.minor][-status]"
options.GroupNameFormat = "'v'VVV";
// note: this option is only necessary when versioning by url segment. the SubstitutionFormat
// can also be used to control the format of the API version in route templates
options.SubstituteApiVersionInUrl = true;
});
}
private static void ConfigureSwagger(
IServiceCollection services,
ApiSecurityOptions apiSecurityOptions)
{
services.AddTransient<IConfigureOptions<SwaggerGenOptions>, ConfigureSwaggerOptions>();
services.AddSwaggerGen(
options =>
{
// add a custom operation filter which sets default values
options.OperationFilter<SwaggerDefaultValues>();
options.OperationFilter<AuthorizeCheckOperationFilter>();
// integrate xml comments
options.IncludeXmlComments(XmlCommentsFilePath);
options.AddSecurityDefinition(
ApiInfo.SchemeOauth2,
ConfigureSecurityDefinitionScheme(apiSecurityOptions));
});
}
private static void ConfigureAuth(
IServiceCollection services,
ApiSecurityOptions apiSecurityOptions)
{
// https://identityserver4.readthedocs.io/en/latest/topics/apis.html
services
.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
.AddJwtBearer(options =>
{
// base-address of your identityserver
options.Authority = apiSecurityOptions.Authority;
// if you are using API resources, you can specify the name here
options.Audience = apiSecurityOptions.Audience;
});
}
private static OpenApiSecurityScheme ConfigureSecurityDefinitionScheme(
ApiSecurityOptions apiSecurityOptions)
{
OpenApiOAuthFlow authCodeFlow = new OpenApiOAuthFlow
{
AuthorizationUrl = new Uri($"{apiSecurityOptions.Authority}/connect/authorize"),
TokenUrl = new Uri($"{apiSecurityOptions.Authority}/connect/token"),
Scopes = new Dictionary<string, string>
{
{ apiSecurityOptions.Audience, "Api access" }
}
};
return new OpenApiSecurityScheme
{
Type = SecuritySchemeType.OAuth2,
Flows = new OpenApiOAuthFlows
{
AuthorizationCode = authCodeFlow
}
};
}
private static string XmlCommentsFilePath
{
get
{
var basePath = PlatformServices.Default.Application.ApplicationBasePath;
var fileName = typeof(Startup).GetTypeInfo().Assembly.GetName().Name + ".xml";
return Path.Combine(basePath, fileName);
}
}
}
}