abpframework / abp

Open Source Web Application Framework for ASP.NET Core. Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET and the ASP.NET Core platforms. Provides the fundamental infrastructure, production-ready startup templates, application modules, UI themes, tooling, guides and documentation.
https://abp.io
GNU Lesser General Public License v3.0
12.27k stars 3.32k forks source link

Documentation for extending ApplicationConfiguration Endpoint #19583

Closed puschie286 closed 1 week ago

puschie286 commented 2 weeks ago

Is there an existing issue for this?

Is your feature request related to a problem? Please describe the problem.

Currently there is no documentation about extending the Application Configuration with AbpApplicationConfigurationOptions / IApplicationConfigurationContributor.

Describe the solution you'd like

Mention that AbpApplicationConfigurationOptions exist and show how to add static information to the ApplicationConfiguration Enpoint by creating an IApplicationConfigurationContributor.

This reduces required initial requests and ensure data is available after initial request

Additional context

Maybe a section about ObjectExtensions would nice to (currently its not even mentioned that extension information are included)

References: AbpApplicationConfigurationAppService

EngincanV commented 2 weeks ago

I wrote an article to show how to extend the application-configuration endpoint, which you can check at https://engincanv.github.io/abp/2022/08/02/extending-the-application-configuration-endpoint.html

Regardless, I agree that we should document it in the Application Configuration document as you said. I'll be working on that.

EngincanV commented 1 week ago

Done: https://github.com/abpframework/abp/pull/19595