Live Chat Icon For mobile
Live Chat Icon
Popular Categories.NET  (143).NET Core  (23)Angular  (38)ASP.NET  (47)ASP.NET Core  (53)ASP.NET MVC  (83)Azure  (26)Blazor  (44)DocIO  (18)Essential JS 2  (64)Essential Studio  (159)Flutter  (46)JavaScript  (133)Microsoft  (96)PDF  (47)React  (29)Succinctly series  (118)Syncfusion  (383)TypeScript  (30)Uno Platform  (2)UWP  (4)Vue  (25)Webinar  (13)Windows Forms  (52)WPF  (86)Xamarin  (104)XlsIO  (20)Other CategoriesBarcode  (4)BI  (29)Bold BI  (3)Build conference  (6)Business intelligence  (53)Button  (4)C#  (97)Chart  (38)Cloud  (8)Company  (445)Dashboard  (4)Data Science  (3)Data Validation  (2)DataGrid  (27)Development  (232)Doc  (7)eBook  (89)Enterprise  (22)Entity Framework  (4)Essential Tools  (14)Excel  (11)Extensions  (6)File Manager  (3)Gantt  (6)Gauge  (4)Git  (3)Grid  (24)HTML  (8)Installer  (1)Knockout  (2)LINQPad  (1)Linux  (1)M-Commerce  (1)Metro Studio  (11)Mobile  (133)Mobile MVC  (9)OLAP server  (1)Orubase  (12)Partners  (20)PDF viewer  (15)Performance  (1)PHP  (1)PivotGrid  (4)Predictive Analytics  (6)Report Server  (3)Reporting  (10)Reporting / Back Office  (11)Rich Text Editor  (5)Road Map  (9)Scheduler  (13)SfDataGrid  (7)Silverlight  (21)Sneak Peek  (12)Solution Services  (2)Spreadsheet  (2)SQL  (4)Stock Chart  (1)Surface  (4)Tablets  (5)Theme  (8)Tips and Tricks  (12)UI  (56)Uncategorized  (68)Unix  (2)User interface  (42)Visual State Manager  (1)Visual Studio  (12)Visual Studio Code  (6)Web  (85)What's new  (53)Windows 8  (19)Windows App  (1)Windows Phone  (15)Windows Phone 7  (9)WinRT  (26)
Share on twitter
Share on facebook
Share on linkedin
How to use Localization in ASP.Net Core Web API

How to Use Localization in an ASP.NET Core Web API

To serve people from any culture who use any language, most web applications nowadays have localization support.

Localization is a process that translates content for a specific culture. It can be used to serve a multilingual, worldwide audience and achieve better market reach.

In this blog, we are going to learn about how to use localization in an ASP.NET Core web API with resource (.resx) files.

Prerequisites

The following are the prerequisites to integrate localization in an ASP.NET Core web API:

Create an ASP.NET Core REST API application

Follow these steps to create an ASP.NET Core REST API application in Visual Studio 2019:

Step 1: In Visual Studio 2019 (v16.4 or higher), go to File > New, and then select Project.

Step 2: Choose Create a new project.

Step 3: Select the ASP.NET Core Web Application template.

Step 4:  Enter a Project name, and then click Create. The project template dialog will be displayed.

Step 5: Select the .NET Core, ASP.NET Core 3.1, API template (highlighted in the following screenshot).

Select .NET Core, ASP.NET Core 3.1, API Template
Select .NET Core, ASP.NET Core 3.1, API Template

Configuring start-up

Step 1: Register the necessary services for the localization process in the ConfigureServices method in the Startup.cs class: AddLocalization() and Configure<RequestLocalizationOptions>().

Add Localization Services
Add Localization Services

Step 2: Add the request localization middleware in the Configure method from the Startup.cs class.

Configure Request Localization Middleware
Configure Request Localization Middleware

Strategy for resource files

Resource files contain localizable strings based on the culture and the controller. We can maintain the resource files in two ways:

  • Single culture resource file per controller.
  • Single culture resource file for all controllers.

Single culture resource file per controller

In this method, you need to maintain a separate resource file for each culture and each controller in any file structure (i.e. dot or path) as mentioned in this documentation.

Example:

If you have two controllers and support for two cultures, then you need to maintain the resource files in the structure shown in the following screenshot.

Here, we have support for the US English and French languages.

Resource File Structure
Resource File Structure

Single culture resource file for all controllers

In this method, you should maintain a single resource file based on culture for all the controllers.

To do this, you need to create an empty class with the same name as the resource file. The namespace of this empty class will be used to find the resource manager and resolve IStringLocalizer<T> abstractions.

Example:

Despite of the number of controllers, you should only maintain one resource file for every culture supported.

Refer to the following screenshot to see this approach in practice.

Resource File Structure
Resource File Structure

How to use localized values in controllers

ASP.NET Core provides built-in support for IStringLocalizer and IStringLocalizer<T> abstractions. These abstractions are used to get the values based on the name of the string resource passed from the respective culture resource file (e.g., HomeController.en-US.resx).

To use localized values in the controllers, you need to inject the IStringLocalizer<T> abstraction based on the resource file structure mapped as shown in the following table.

Controller NameDependency Injection of IStringLocalizer<T>Resource File Structure
HomeControllerIStringLocalizer<HomeController>Resources/Controllers/HomeController.en-US.resx
AboutControllerIStringLocalizer<AboutController>Resources/Controllers/AboutController.en-US.resx
For all controllersIStringLocalizer<Resource>Resource.en-US.resx

Based on injecting the IStringLocalizer<T> abstraction, the string localizer will map the resource file through the value passed to the shared resource (T). This string localizer will then return the mapped value from the resource file based on the name of the string resource you have passed.

IStringLocalizer Abstraction
IStringLocalizer Abstraction

Resources

You can find a copy of these samples in the following GitHub locations:

Conclusion

In this blog, we learned about implementing localization in an ASP .NET Core web API application. This feature helps to serve multilingual people from diverse cultures.

Syncfusion provides over 70 high-performance, lightweight, modular, and responsive ASP.NET Core UI controls such as DataGrid, Charts, and Scheduler, and all of them have built-in support for localization. You can use them to improve your application development.

Please share your feedback on this blog in the comments section. You can also contact us through our support forum, Direct-Trac, or feedback portal. We are waiting to hear from you!

Tags:

Share this post:

Share on twitter
Share on facebook
Share on linkedin

Comments (6)

can we have comman resource files for all controllers ?

Hi ABHIJEET SHARMA,

Yes we can have a single common resource file for all controllers per culture based. You can refer the below sample for your reference.

Localization Sample: https://github.com/RaguMP/Samples/tree/master/LocalizationSampleSingleResxFile

Regards,
Ragunaathan M P

Hello. I am wondering if I can move single resource culture file to any library project? Are does need to be part of the project where Controllers are present?

thanks,

Hi Uma,

Yes, we can maintain resource files in any library project and can refer in API project. But we need to maintain an empty class with the same name as the resource file where the namespace of this empty class will be used to find the resource manager, and resolve IStringLocalizer abstractions as explained in this blog.

Regards,
Ragunaathan M P

can you provide an example? I am struggling to make it work. I am using the resource file on another project

Hi Rashid,

Kindly find the below sample which I have prepared by referring resource files from another project.

Localization Sample: https://github.com/RaguMP/Samples/tree/master/LocalizationSampleSingleResxFileSeparateProj

Regards,
Ragunaathan M P

Leave a comment

Popular Now

Be the first to get updates

Subscribe RSS feed
Scroll To Top