Does Abp support scalar implementation of restful api documentation?

[huangmingji]

Does Abp support scalar implementation of restful api documentation? https://scalar.com/

[realLiangshiwei]

ABP is a standard ASP.NET Core application, you can use scalar without any problem.

[huangmingji]

No errors

[realLiangshiwei]

Share a test project, thanks.

[huangmingji]

https://github.com/huangmingji/abp-scalar-test

[realLiangshiwei]

Try

context.Services.AddOpenApi(options =>
{
    options.ShouldInclude = (_) => true;
});

[huangmingji]

It works now, thank you.

[laugh0608]

It works now, thank you.

Sorry to bother you, I would like to ask if I have used this method in the latest version of ABP, but the scalar will display: Document 'v1' could not be loaded , And unable to generate any API documentation, may I ask if you have a solution?

很抱歉打扰您，我想请教一下，我在最新版的abp中使用了该方法，但是scalar会显示：Document 'v1' could not be loaded , 并且无法生成任何api文档，想请教一下您是否有解决办法？

MyCode:

我的代码：

HttpApiHostModule

Program

[mavado83]

Hi, yes it still works. In HttpApiHostModule I have in OnApplicationInitialization:

((WebApplication)app).MapOpenApi();
 ((WebApplication)app).MapScalarApiReference(opt =>
 {
     opt.Title = "API";
     opt.TagSorter = TagSorter.Alpha;
 }); // scalar/v1

And in ConfigureServices in HttpApiHostModule :

private static void ConfigureOpenApi(ServiceConfigurationContext context)
{
    context.Services.AddOpenApi(opt =>
    {
        opt.ShouldInclude = _ => true;
    });
}

I also run Swagger along with Scalar.
Maybe you can first try these basics and then expand with the requirements you need.

[laugh0608]

Thank you very much. I believe I've found a solution. Thank you again for your response.

[mavado83]

@realLiangshiwei Another question: When using Scalar I get an RequestVerificationToken validation exception, this is because ABP has adjustments for swagger to auto-include this token on every request (abp.js) Is something like this also possible for Scalar? For now I have disabled AntiForgeryValidation when in development mode.

[realLiangshiwei]

Currently, there seems to be no good way to do it, you can try clearing cookies.