13
Gibt es eine Möglichkeit, dies zu tun?Wie erzeuge ich API-Dokumentation für SignalR
Ich habe swashbuckle Generieren von Inhalten für meine anderen APIs, aber ich glaube nicht, dass es für SignalR funktioniert.
A
Antwort
1
Angenommen, Sie verwenden Asp.NET Core, kann benutzerdefinierte Dokumentation beim Start injiziert werden.
In Ihrem Startup.ConfigureServices Sie sollten bereits einen Swagger Abschnitt haben:
services.AddSwaggerGen(c =>
{
...
})
Fügen Sie einfach eine benutzerdefinierte XML-Datei Swagger Dokumentation:
services.AddSwaggerGen(c =>
{
c.IncludeXmlComments("custom_doc.xml");
})
wo custom_doc.xml ist eine Standard-C# XML-Dokumentationsdatei.
Ich bin sehr interessiert an der gleichen Sache hier, obwohl ich zunehmend unter dem Eindruck bin, dass SignalR für meist interne Kommunikation, d. zwischen den ersten Parteien. Kombiniere das mit der dynamischen Natur von SignalR, ich glaube nicht, dass es so solide ist wie Swashbuckle. Ich werde mit einer Bibliothek experimentieren, die TypScript-Schnittstellen generiert, aber noch keinen Workflow eingerichtet hat. –
Wenn Sie eine öffentliche "Realtime" API bereitstellen möchten, wäre ein Callback-Schema möglicherweise besser geeignet. So etwas wie [Facebook] (https://developers.facebook.com/docs/graph-api/real-time-updates/v2.3) oder [Github] (https://developer.github.com/webhooks/) , aber das hilft nicht wirklich für einfache Webseitenprojekte. –
Ich konnte keine Tools finden, um Swagger-Dokumentation für SignalR zu erstellen, obwohl ich jemanden gerne auf etwas aufmerksam machen würde, das ich übersehen habe. Ich bin überrascht, dass diese Frage nicht einmal einen Versuch auf eine Antwort hatte. – Nathan