Web Api Dokumentation
Guten Morgen,
ich stehe nun vor einer relativ ausgereiften WebApi und muss nun den Usern irgendwie nahe bringen, wie welche Methode aufzurufen ist, was sie als Ergebnis erwarten dürfen usw..
Ich bin gerade über diesen Artikel gestolpert:
Creating Help Pages for ASP.NET Web API
Benutzt ihr auch diese Technik oder hat sich für euch ein anderer Ablauf als "besser" herausgestellt?
MfG
wax
Ich verwende mittlerweile OData bei meinen APIs, die sich durch die Metadaten von selbst dokumentiert und Client-Code generierbar macht.
Jedoch zwingt OData den Entwickler dazu die API strukturierter umzusetzen als manch einem lieb ist 😉
- performance is a feature -
Microsoft MVP - @Website - @AzureStuttgart - github.com/BenjaminAbt - Sustainable Code
Hallo zusammen,
danke für die Antworten! Ich habe mir per Swashbuckle nun eine Swagger-Doku eingerichtet.
Wobei es noch das absolute Basic-Template ist.
Wie kann ich nun zusätzliche Beschreibungen für die gefundene Controller-Methoden definieren?
Ich hätte gedacht, dass Swashbuckle sich dazu die Methoden-Beschreibungen
<summary>description</summary>
zur Hand nimmt. Anscheinend ist dem nicht so?!
Wie muss ich nun vorgehen?
Auf http://editor.swagger.io/#/ werden alle Infos als YAML niedergeschrieben und in einem anderen Tutorial habe ich gesehen wie jemand "IncludeXmlComments" aufruft.
Wisst ihr da genaueres welcher Weg zu bevorzugen ist, bzw. wie man das nun anstellt?
MfG
wax
Ok hab schon was gefunden: Swashbuckle
und
asp-net-web-api-documentation-using-swagger
Jeweils in den letzen Abschnitten erfährt man alles Wissenswerte zu dem Thema.
MfG
wax