c# - 如何为 SignalR 生成 API 文档

Question

有办法吗？

我有 swashbuckle 为我的其他 API 生成内容，但我认为它不适用于 SignalR。

Answer 1

这是一个可以帮助你的 Nuget 包。

Nuget 链接:https://www.nuget.org/packages/SignalRSwaggerGen/

Github 链接:https://github.com/Dorin-Mocan/SignalRSwaggerGen/wiki

首先，您需要使用 SignalRSwaggerGen.Attributes 命名空间中的属性来装饰您的 SignalR 集线器:

[SignalRHub]
public class SomeHub : Hub
{
}

然后将 SignalRSwaggerGen 添加到 Swagger 生成器:

services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new OpenApiInfo { Title = "Some API v1", Version = "v1" });
    // here some other configurations maybe...
    options.AddSignalRSwaggerGen();
});

更多信息请引用 Github 文档。