├── MinimalApiDemo ├── appsettings.Development.json ├── appsettings.json ├── Services │ └── HelloService.cs ├── GlobalUsings.cs ├── MinimalApiDemo.csproj ├── Properties │ └── launchSettings.json └── Program.cs ├── README.md ├── MinimalApiDemo.sln └── .gitignore /MinimalApiDemo/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Information" 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /MinimalApiDemo/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft": "Warning", 6 | "Microsoft.Hosting.Lifetime": "Information" 7 | } 8 | }, 9 | "AllowedHosts": "*" 10 | } 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # aspnetcore-minimal-api 2 | Example of a minimal API and some basics features (Work in progress): 3 | 4 | Swagger doc 5 | 6 | Authentication 7 | 8 | CORS 9 | 10 | Endpoint protected by authentication 11 | 12 | Dependency injection without using [FromService] attributes 13 | 14 | C# 9 & 10 features such as Top-level programs, Global gsings, File-scoped namespaces, Attributes on lambdas 15 | -------------------------------------------------------------------------------- /MinimalApiDemo/Services/HelloService.cs: -------------------------------------------------------------------------------- 1 | namespace MinimalApiDemo.Services; 2 | 3 | public interface IHelloService 4 | { 5 | string Hello(ClaimsPrincipal user, bool isHappy); 6 | } 7 | 8 | public class HelloService : IHelloService 9 | { 10 | public string Hello(ClaimsPrincipal user, bool isHappy) 11 | { 12 | var hello = $"Hello {user.Identity.Name}"; 13 | 14 | if (isHappy) 15 | return $"{hello}, you seem to be happy today"; 16 | return hello; 17 | } 18 | } -------------------------------------------------------------------------------- /MinimalApiDemo/GlobalUsings.cs: -------------------------------------------------------------------------------- 1 | global using Microsoft.AspNetCore.Authentication.JwtBearer; 2 | global using Microsoft.AspNetCore.Builder; 3 | global using Microsoft.AspNetCore.Http; 4 | global using Microsoft.Extensions.DependencyInjection; 5 | global using Microsoft.Extensions.Hosting; 6 | global using Microsoft.OpenApi.Models; 7 | global using MinimalApiDemo.Services; 8 | global using System.Collections.Generic; 9 | global using System.Net; 10 | global using System.Security.Claims; 11 | global using System; 12 | -------------------------------------------------------------------------------- /MinimalApiDemo/MinimalApiDemo.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net6.0 5 | preview 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /MinimalApiDemo/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "iisSettings": { 3 | "windowsAuthentication": false, 4 | "anonymousAuthentication": true, 5 | "iisExpress": { 6 | "applicationUrl": "http://localhost:48256", 7 | "sslPort": 44372 8 | } 9 | }, 10 | "profiles": { 11 | "MinimalApiDemo": { 12 | "commandName": "Project", 13 | "dotnetRunMessages": true, 14 | "launchBrowser": true, 15 | "applicationUrl": "https://localhost:5001;http://localhost:5000", 16 | "environmentVariables": { 17 | "ASPNETCORE_ENVIRONMENT": "Development" 18 | } 19 | }, 20 | "IIS Express": { 21 | "commandName": "IISExpress", 22 | "launchBrowser": true, 23 | "environmentVariables": { 24 | "ASPNETCORE_ENVIRONMENT": "Development" 25 | } 26 | } 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /MinimalApiDemo.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.0.31521.260 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MinimalApiDemo", "MinimalApiDemo\MinimalApiDemo.csproj", "{FC640443-0E14-4AD6-B147-184212A3E8C9}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {FC640443-0E14-4AD6-B147-184212A3E8C9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {FC640443-0E14-4AD6-B147-184212A3E8C9}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {FC640443-0E14-4AD6-B147-184212A3E8C9}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {FC640443-0E14-4AD6-B147-184212A3E8C9}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {66EF8C62-0371-46BF-858E-BC0BB99AC35C} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /MinimalApiDemo/Program.cs: -------------------------------------------------------------------------------- 1 | // Configure services 2 | var builder = WebApplication.CreateBuilder(args); 3 | 4 | builder.Services.AddAuthentication(options => 5 | { 6 | options.DefaultAuthenticateScheme = 7 | options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme; 8 | }).AddJwtBearer(options => 9 | { 10 | options.Authority = "https://login.microsoftonline.com/xxxxxxxxxxxxxxxxxxxxxxxxxx"; 11 | options.Audience = "xxxxxxxxxxxxxxxxxxxxxxxxx"; 12 | options.TokenValidationParameters.ValidateLifetime = false; 13 | options.TokenValidationParameters.ClockSkew = TimeSpan.Zero; 14 | }); 15 | 16 | builder.Services.AddAuthorization(); 17 | 18 | builder.Services.AddCors(); 19 | 20 | builder.Services.AddScoped(); 21 | 22 | builder.Services.AddEndpointsApiExplorer(); 23 | 24 | builder.Services.AddSwaggerGen(c => 25 | { 26 | c.SwaggerDoc("v1", new OpenApiInfo { Title = "Api", Version = "v1" }); 27 | c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme 28 | { 29 | Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", 30 | Name = "Authorization", 31 | In = ParameterLocation.Header, 32 | Type = SecuritySchemeType.ApiKey, 33 | Scheme = "Bearer" 34 | }); 35 | c.AddSecurityRequirement(new OpenApiSecurityRequirement() 36 | { 37 | { 38 | new OpenApiSecurityScheme 39 | { 40 | Reference = new OpenApiReference 41 | { 42 | Type = ReferenceType.SecurityScheme, 43 | Id = "Bearer" 44 | }, 45 | Scheme = "oauth2", 46 | Name = "Bearer", 47 | In = ParameterLocation.Header, 48 | 49 | }, 50 | new List() 51 | }}); 52 | }); 53 | 54 | // Configure and enable middlewares 55 | var app = builder.Build(); 56 | 57 | if (app.Environment.IsDevelopment()) 58 | { 59 | app.UseDeveloperExceptionPage(); 60 | } 61 | 62 | app.UseSwagger(); 63 | app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "Api v1")); 64 | 65 | app.UseCors(p => 66 | { 67 | p.AllowAnyOrigin(); 68 | p.WithMethods("GET"); 69 | p.AllowAnyHeader(); 70 | }); 71 | 72 | app.UseAuthentication(); 73 | app.UseAuthorization(); 74 | 75 | // GET endpoint where IHelloService and ClaimsPrincipal are injected by dependency no needs to use anymore [FromServices] attribute 76 | // ClaimsPrincipal is automatically injected 77 | app.MapGet("/Hello", (bool? isHappy, IHelloService service, ClaimsPrincipal user) => 78 | 79 | { 80 | if (isHappy is null) { return Results.BadRequest("Please say if you are happy or not :-)"); } 81 | 82 | return Results.Ok(service.Hello(user, (bool)isHappy)); 83 | }) 84 | .Produces((int)HttpStatusCode.OK) // Response description 85 | .Produces((int)HttpStatusCode.BadRequest) // Response description 86 | .WithName("Hello 1") // Response Id 87 | .WithTags("Hellos"); // group description 88 | 89 | app.MapGet("/Hello2", () => 90 | { 91 | return Results.Ok("Hello again !"); 92 | }) 93 | .Produces((int)HttpStatusCode.OK) // Response description 94 | .Produces((int)HttpStatusCode.BadRequest) // Response description 95 | .WithName("Hello 2") // Response Id 96 | .WithTags("Hellos"); // group description 97 | 98 | 99 | // Run the app 100 | app.Run(); 101 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | --------------------------------------------------------------------------------