imhven
/
abp
mirror of https://github.com/abpframework/abp
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '72ee029172'
${ noResults }
abp/docs/en/API/Application-Localization.md

1.8 KiB
Raw Blame History

Application Localization Endpoint

ABP Framework provides a pre-built and standard endpoint that returns all the localization resources and texts defined in the server.

If you have started with ABP's startup solution templates and using one of the official UI options, then all these are set up for you and you don't need to know these details. However, if you are building a UI application from scratch, you may want to know this endpoint.

HTTP API

/api/abp/application-localization is the main URL of the HTTP API that returns the localization data as a JSON string. I accepts the following query string parameters:

  • cultureName (required): A culture code to get the localization data, like en or en-US.
  • onlyDynamics (optional, default: false): Can be set to true to only get the dynamically defined localization resources and texts. If your client-side application shares the same localization resources with the server (like ABP's Blazor and MVC UIs), you can set onlyDynamics to true.

Example request:

/api/abp/application-localization?cultureName=en

Script

For ASP.NET Core MVC (Razor Pages) applications, the same localization data is also available on the JavaScript side. /Abp/ApplicationLocalizationScript is the URL of the script that is auto-generated based on the HTTP API above.

Example request:

/Abp/ApplicationLocalizationScript?cultureName=en

See the JavaScript API document for the ASP.NET Core UI.

Other UI types provide services native to the related platform. For example, see the Angular UI localization documentation to learn how to use the localization values exposes by this endpoint.