├── .gitignore ├── LICENSE ├── LocalizationDemo ├── GreetingEndpoints │ ├── Greeting.GreetingRequest.cs │ ├── Greeting.GreetingResponse.cs │ └── Greeting.cs ├── LocalizationDemo.csproj ├── LocalizationDemo.sln ├── Program.cs ├── Properties │ └── launchSettings.json ├── Resources │ ├── Messages.Designer.cs │ ├── Messages.de-DE.resx │ ├── Messages.en-AU.resx │ ├── Messages.en-US.resx │ └── Messages.resx ├── WeatherForecast.cs ├── appsettings.Development.json └── appsettings.json └── README.md /.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 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 NimblePros 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /LocalizationDemo/GreetingEndpoints/Greeting.GreetingRequest.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Mvc; 2 | 3 | namespace DL.Backend.Web.Endpoints.LanguageEndpoints; 4 | 5 | public class GreetingRequest 6 | { 7 | [FromQuery] 8 | public string Name { get; set; } 9 | } 10 | -------------------------------------------------------------------------------- /LocalizationDemo/GreetingEndpoints/Greeting.GreetingResponse.cs: -------------------------------------------------------------------------------- 1 | namespace DL.Backend.Web.Endpoints.LanguageEndpoints; 2 | 3 | public class GreetingResponse 4 | { 5 | public string Greeting { get; set; } 6 | public string GreetingFormatString { get; set; } 7 | } 8 | -------------------------------------------------------------------------------- /LocalizationDemo/GreetingEndpoints/Greeting.cs: -------------------------------------------------------------------------------- 1 | using Ardalis.ApiEndpoints; 2 | using LocalizationDemo.Resources; 3 | using Microsoft.AspNetCore.Mvc; 4 | using Microsoft.Extensions.Localization; 5 | using Swashbuckle.AspNetCore.Annotations; 6 | 7 | namespace DL.Backend.Web.Endpoints.LanguageEndpoints; 8 | public class Greeting : EndpointBaseAsync 9 | .WithRequest 10 | .WithActionResult 11 | { 12 | private readonly IStringLocalizer _localizer; 13 | private readonly ILogger _logger; 14 | 15 | public Greeting( 16 | IStringLocalizer localizer, 17 | ILogger logger) 18 | { 19 | _localizer = localizer; 20 | _logger = logger; 21 | } 22 | 23 | [HttpGet("/Greeting")] 24 | [SwaggerOperation( 25 | Summary = "Returns a localized greeting", 26 | Description = "Returns a localized greeting", 27 | OperationId = "DL.Greeting", 28 | Tags = new[] { "LanguageEndpoints" }) 29 | ] 30 | public override async Task> HandleAsync([FromQuery] GreetingRequest request, 31 | CancellationToken cancellationToken = default) 32 | { 33 | var localizedString = _localizer["Greeting"]; 34 | 35 | _logger.LogDebug("Localized String: name={0};value={1};\nresourceNotFound={2};searchedLocation={3}", localizedString.Name, 36 | localizedString.Value, localizedString.ResourceNotFound, localizedString.SearchedLocation); 37 | 38 | var response = new GreetingResponse 39 | { 40 | GreetingFormatString = localizedString.Value, 41 | Greeting = String.Format(localizedString.Value, request.Name) 42 | }; 43 | 44 | return Ok(response); 45 | } 46 | 47 | } 48 | -------------------------------------------------------------------------------- /LocalizationDemo/LocalizationDemo.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | net8.0 5 | enable 6 | enable 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | True 18 | True 19 | Messages.resx 20 | 21 | 22 | 23 | 24 | 25 | PublicResXFileCodeGenerator 26 | 27 | 28 | PublicResXFileCodeGenerator 29 | Messages.Designer.cs 30 | 31 | 32 | 33 | 34 | -------------------------------------------------------------------------------- /LocalizationDemo/LocalizationDemo.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.0.31903.59 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "LocalizationDemo", "LocalizationDemo.csproj", "{7F0246DD-D0B1-4132-84AA-7068EBB17F74}" 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 | {7F0246DD-D0B1-4132-84AA-7068EBB17F74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {7F0246DD-D0B1-4132-84AA-7068EBB17F74}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {7F0246DD-D0B1-4132-84AA-7068EBB17F74}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {7F0246DD-D0B1-4132-84AA-7068EBB17F74}.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 = {AC0AA985-6034-40F5-9435-8C5D9C47429E} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /LocalizationDemo/Program.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Localization; 2 | using Microsoft.Extensions.Options; 3 | using System.Globalization; 4 | 5 | var builder = WebApplication.CreateBuilder(args); 6 | 7 | // Add services to the container. 8 | 9 | builder.Services.AddControllers(); 10 | 11 | builder.Services.AddLocalization(); 12 | builder.Services.Configure( 13 | options => 14 | { 15 | var supportedCultures = new List 16 | { 17 | new CultureInfo("en-US"), 18 | new CultureInfo("en-AU"), 19 | new CultureInfo("de-DE") 20 | }; 21 | 22 | options.DefaultRequestCulture = new RequestCulture(culture: "en-US", uiCulture: "en-US"); 23 | options.SupportedCultures = supportedCultures; 24 | options.SupportedUICultures = supportedCultures; 25 | }); 26 | 27 | 28 | // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle 29 | builder.Services.AddEndpointsApiExplorer(); 30 | builder.Services.AddSwaggerGen(); 31 | 32 | var app = builder.Build(); 33 | 34 | // Configure the HTTP request pipeline. 35 | if (app.Environment.IsDevelopment()) 36 | { 37 | app.UseSwagger(); 38 | app.UseSwaggerUI(); 39 | } 40 | 41 | var localizeOptions = app.Services.GetService>(); 42 | app.UseRequestLocalization(localizeOptions.Value); 43 | 44 | app.UseHttpsRedirection(); 45 | 46 | app.UseAuthorization(); 47 | 48 | app.MapControllers(); 49 | 50 | app.Run(); 51 | -------------------------------------------------------------------------------- /LocalizationDemo/Properties/launchSettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://json.schemastore.org/launchsettings.json", 3 | "iisSettings": { 4 | "windowsAuthentication": false, 5 | "anonymousAuthentication": true, 6 | "iisExpress": { 7 | "applicationUrl": "http://localhost:44242", 8 | "sslPort": 44395 9 | } 10 | }, 11 | "profiles": { 12 | "LocalizationDemo": { 13 | "commandName": "Project", 14 | "dotnetRunMessages": true, 15 | "launchBrowser": true, 16 | "launchUrl": "swagger", 17 | "applicationUrl": "https://localhost:7067;http://localhost:5155", 18 | "environmentVariables": { 19 | "ASPNETCORE_ENVIRONMENT": "Development" 20 | } 21 | }, 22 | "IIS Express": { 23 | "commandName": "IISExpress", 24 | "launchBrowser": true, 25 | "launchUrl": "swagger", 26 | "environmentVariables": { 27 | "ASPNETCORE_ENVIRONMENT": "Development" 28 | } 29 | } 30 | } 31 | } 32 | -------------------------------------------------------------------------------- /LocalizationDemo/Resources/Messages.Designer.cs: -------------------------------------------------------------------------------- 1 | //------------------------------------------------------------------------------ 2 | // 3 | // This code was generated by a tool. 4 | // Runtime Version:4.0.30319.42000 5 | // 6 | // Changes to this file may cause incorrect behavior and will be lost if 7 | // the code is regenerated. 8 | // 9 | //------------------------------------------------------------------------------ 10 | 11 | namespace LocalizationDemo.Resources { 12 | using System; 13 | 14 | 15 | /// 16 | /// A strongly-typed resource class, for looking up localized strings, etc. 17 | /// 18 | // This class was auto-generated by the StronglyTypedResourceBuilder 19 | // class via a tool like ResGen or Visual Studio. 20 | // To add or remove a member, edit your .ResX file then rerun ResGen 21 | // with the /str option, or rebuild your VS project. 22 | [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")] 23 | [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] 24 | [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] 25 | public class Messages { 26 | 27 | private static global::System.Resources.ResourceManager resourceMan; 28 | 29 | private static global::System.Globalization.CultureInfo resourceCulture; 30 | 31 | [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] 32 | internal Messages() { 33 | } 34 | 35 | /// 36 | /// Returns the cached ResourceManager instance used by this class. 37 | /// 38 | [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] 39 | public static global::System.Resources.ResourceManager ResourceManager { 40 | get { 41 | if (object.ReferenceEquals(resourceMan, null)) { 42 | global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("LocalizationDemo.Resources.Messages", typeof(Messages).Assembly); 43 | resourceMan = temp; 44 | } 45 | return resourceMan; 46 | } 47 | } 48 | 49 | /// 50 | /// Overrides the current thread's CurrentUICulture property for all 51 | /// resource lookups using this strongly typed resource class. 52 | /// 53 | [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] 54 | public static global::System.Globalization.CultureInfo Culture { 55 | get { 56 | return resourceCulture; 57 | } 58 | set { 59 | resourceCulture = value; 60 | } 61 | } 62 | 63 | /// 64 | /// Looks up a localized string similar to Hello, {0}!. 65 | /// 66 | public static string Greeting { 67 | get { 68 | return ResourceManager.GetString("Greeting", resourceCulture); 69 | } 70 | } 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /LocalizationDemo/Resources/Messages.de-DE.resx: -------------------------------------------------------------------------------- 1 |  2 | 3 | 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 | text/microsoft-resx 110 | 111 | 112 | 2.0 113 | 114 | 115 | System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 116 | 117 | 118 | System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 119 | 120 | 121 | Guten Tag, {0}! 122 | 123 | -------------------------------------------------------------------------------- /LocalizationDemo/Resources/Messages.en-AU.resx: -------------------------------------------------------------------------------- 1 |  2 | 3 | 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 | text/microsoft-resx 110 | 111 | 112 | 2.0 113 | 114 | 115 | System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 116 | 117 | 118 | System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 119 | 120 | 121 | G'day, {0}! 122 | 123 | -------------------------------------------------------------------------------- /LocalizationDemo/Resources/Messages.en-US.resx: -------------------------------------------------------------------------------- 1 |  2 | 3 | 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 | text/microsoft-resx 110 | 111 | 112 | 2.0 113 | 114 | 115 | System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 116 | 117 | 118 | System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 119 | 120 | 121 | Hello, {0}! 122 | 123 | -------------------------------------------------------------------------------- /LocalizationDemo/Resources/Messages.resx: -------------------------------------------------------------------------------- 1 |  2 | 3 | 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 | text/microsoft-resx 110 | 111 | 112 | 2.0 113 | 114 | 115 | System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 116 | 117 | 118 | System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 119 | 120 | 121 | Hello, {0}! 122 | 123 | -------------------------------------------------------------------------------- /LocalizationDemo/WeatherForecast.cs: -------------------------------------------------------------------------------- 1 | namespace LocalizationDemo; 2 | 3 | public class WeatherForecast 4 | { 5 | public DateTime Date { get; set; } 6 | 7 | public int TemperatureC { get; set; } 8 | 9 | public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); 10 | 11 | public string? Summary { get; set; } 12 | } 13 | -------------------------------------------------------------------------------- /LocalizationDemo/appsettings.Development.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning" 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /LocalizationDemo/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "Logging": { 3 | "LogLevel": { 4 | "Default": "Information", 5 | "Microsoft.AspNetCore": "Warning", 6 | "Microsoft.Extensions.Localization": "Debug", 7 | } 8 | }, 9 | "AllowedHosts": "*" 10 | } 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Api Localization Demo 2 | 3 | A simple API project showing how to use ASP.NET Core Localization 4 | 5 | ## Run the Code 6 | 7 | `dotnet run` should be sufficient. 8 | 9 | The simplest way to demo the behavior is using a tool like Postman. Make a GET request to `/Greeting?Name=world` and by default you should see a response with a greeting of "Hello, world!". Note that the `accept-language` header is unchecked, so is not being sent. 10 | 11 | ![Postman showing request with default greeting](https://user-images.githubusercontent.com/782127/149388908-b23844b3-e50f-4888-92fe-a1382e6f6c6c.png) 12 | 13 | Change the `Accept-Language` header to `en-AU` and you should get a different greeting (of "G'day, world!"). 14 | 15 | ![Postman showing request with en-AU greeting](https://user-images.githubusercontent.com/782127/149388754-cf1b4f24-4ffb-4345-908a-6d597eda1bda.png) 16 | 17 | ## Adding Another Language 18 | 19 | To add support for another language, you should copy/paste an existing `Messages.en-US.resx` file, change the name to `Messages.xx-XX.resx` for the language you're adding, and make sure to specify that it will perform code generation (dropdown when you double-click the file). 20 | 21 | Then, you need to add it to the list of supported langages in the app startup. 22 | 23 | ## Referencing Resource Files 24 | 25 | The namespace of a resource file **and** its folder path are both important to whether or not it will be found. For instance, imagine you're using Areas and you have an application "Acme.Project" with an area called "Members" and inside of that you have a Resources folder and a `Messages.resx` file. Its namespace might be `Acme.Project.Members.Resources.Messages` for the generated class. But ASP.NET Core Localization likely won't find these resources, even if you inspect the assembly and see them present there, because the actual folder is in the "Areas" folder and "Areas" didn't make it into the namespace. Thus, the physical path and the namespace do not match, which is apparently required. 26 | 27 | ## Why Inject IStringLocalizer vs. Directly Referencing Resource Strings 28 | 29 | It's simpler to just reference things as `MyResource.MessageName` rather than doing the whole `IStringLocalizer` and `LocalizedString` bit. But it is less flexible. Here are some benefits of using the service: 30 | 31 | Injecting an instance of `IStringLocalizer` has several advantages over directly referencing the localized resources in a strongly-typed manner: 32 | 33 | ### Dynamic Culture Switching 34 | 35 | Using IStringLocalizer ensures that the correct resource for the current culture is used, even if the culture changes dynamically during the lifetime of the application. This is particularly useful in web applications where the user can switch languages. 36 | 37 | ### Resource Fallback 38 | 39 | IStringLocalizer automatically handles resource fallback if a specific culture's resource is not found. It will fallback to a default culture or the invariant culture if necessary. 40 | 41 | ### Missing Resource Detection 42 | 43 | IStringLocalizer provides information about whether a resource was found or not via the ResourceNotFound property. This can be useful for logging and debugging purposes. 44 | 45 | ### Flexibility and Extensibility 46 | 47 | By using IStringLocalizer, you can easily extend the localization mechanism to support other ways of retrieving localized strings, such as from a database, without changing your controller code. 48 | 49 | ### Consistency with ASP.NET Core Localization 50 | 51 | It aligns with the ASP.NET Core localization system, which is designed to work with IStringLocalizer. This makes the code more consistent and maintainable, especially for developers who are familiar with ASP.NET Core practices. 52 | 53 | ### Dependency Injection Benefits 54 | 55 | Using dependency injection to inject IStringLocalizer follows the principles of dependency injection, making your code more modular, testable, and adhering to SOLID principles. 56 | 57 | ## References 58 | 59 | - [How to Use Localization in an ASP.NET Core Web API](https://www.syncfusion.com/blogs/post/how-to-use-localization-in-an-asp-net-core-web-api.aspx) 60 | --------------------------------------------------------------------------------