We have an issue when we try to run web(backofficeweb) application after adding DocsAdminWebModule and DocsAdminHttpApiClientModule. #10059

4 Answer(s)

• 

  0

  AI-Bot created yesterday

  Support Team ABP Agent

  1. Solution The exception means an endpoint discovered by ApiExplorer (OpenAPI/Swagger) is coming from a conventionally-routed action. In your case, it’s the generated client proxy for Volo.Docs Admin (DocumentPdfAdminClientProxy.GeneratePdfAsync). This happens when MVC’s conventional controller discovery and the client proxy (which ApiExplorer thinks is an API surface) are both in the pipeline without proper attribute routing metadata.

  Apply one of the following fixes (prefer the first):

  • Fix A: Exclude client proxy types from ApiExplorer Add an MVC option to ignore ApiExplorer for the Docs Admin HttpApi Client assembly types.

  using Microsoft.AspNetCore.Mvc;
    using Microsoft.Extensions.DependencyInjection;
    using Volo.Docs.Admin.HttpApi.Client; // for assembly reference
  
    public override void ConfigureServices(ServiceConfigurationContext context)
    {
        // ... your existing registrations
  
        Configure<MvcOptions>(options =>
        {
            options.Conventions.Add(new ApiExplorerVisibilityConvention(type =>
                type.Assembly == typeof(DocsAdminHttpApiClientModule).Assembly,
                isVisible: false));
        });
    }
  
    // helper convention
    public sealed class ApiExplorerVisibilityConvention : Microsoft.AspNetCore.Mvc.ApplicationModels.IApplicationModelConvention
    {
        private readonly Func<Type, bool> _typePredicate;
        private readonly bool _isVisible;
  
        public ApiExplorerVisibilityConvention(Func<Type, bool> typePredicate, bool isVisible)
        {
            _typePredicate = typePredicate;
            _isVisible = isVisible;
        }
  
        public void Apply(Microsoft.AspNetCore.Mvc.ApplicationModels.ApplicationModel application)
        {
            foreach (var controller in application.Controllers)
            {
                if (_typePredicate(controller.ControllerType.AsType()))
                {
                    controller.ApiExplorer.IsVisible = _isVisible;
                }
            }
        }
    }
  

  Explanation: The Docs HttpApi Client assembly contains typed client proxies (used by your Web app to call the Docs service). They are not real MVC API controllers and shouldn’t participate in ApiExplorer/endpoint discovery. This convention hides them from ApiExplorer to prevent the “ApiExplorer enabled + conventional routing” conflict.

  • Fix B: Disable ApiExplorer at controller/action level (if you have access) If a specific generated/proxy controller is being picked up, you can add:

  [ApiExplorerSettings(IgnoresApi = true)]
  

  on the controller or action. However, for generated client proxies, Fix A is more robust.

  • Fix C: Ensure all discovered controllers use attribute routing (not recommended here) Converting affected controllers to attribute routing resolves the mismatch, but since the offending type is a client proxy (not meant to expose HTTP endpoints), hiding it from ApiExplorer is the correct approach.

  • About MapMetrics and UseConfiguredEndpoints The crash occurs when endpoints are finalized (app.UseConfiguredEndpoints), where MVC builds its action descriptors. The above fix prevents the proxy from being treated as an MVC action, so MapMetrics and endpoint configuration can proceed normally.

  2. Sources

  • https://docs.abp.io/en/commercial/latest/modules/docs
  • https://github.com/abpframework/abp

  ---

  This response was generated by AI. If it didn’t solve your problem, feel free to post a new answer — our support team will jump in to help you soon.

  Save Cancel
• 

  0

  maliming created yesterday

  Support Team Fullstack Developer

  hi

  We will check and fix it.

  Thanks.

  Save Cancel
• 

  0

  consultant.ahmet.ulusoy created yesterday

  Hi Ma,

  Thank you for your help, i fixed it with solution A.

  Best regards,

  Ahmet

  Save Cancel
• 

  0

  maliming created yesterday

  Support Team Fullstack Developer

  https://github.com/abpframework/abp/pull/24094

  Great

  Save Cancel