Come posso generare documentazione API per SignalR

Question

C'è un modo per farlo?

Ho uno swashbuckle che genera contenuti per le mie altre API ma non credo che funzioni per SignalR.

Answer 1

Supponendo che si stia utilizzando Asp.NET Core, la documentazione personalizzata può essere iniettata all'avvio.

Nella tua Startup.ConfigureServices si dovrebbe già avere una sezione Swagger:

services.AddSwaggerGen(c => 
{ 
    ... 
}) 

Basta aggiungere un file XML personalizzato alla documentazione Swagger:

services.AddSwaggerGen(c => 
{ 
    c.IncludeXmlComments("custom_doc.xml"); 
}) 

dove custom_doc.xml è un C# file di documentazione XML standard.