ServiceStack OpenAPI Route/Tag Beschreibung

Question

Ich habe mein Projekt aktualisiert, um die neueste Version von ServiceStack zu verwenden und das OpenApiFeature anstelle von SwaggerFeature zu verwenden.

Die Beschreibungen, die ich in der RouteSummary angegeben habe, werden in Swagger angezeigt, aber unter OpenApi scheinen sie nicht berücksichtigt zu werden. Gibt es einen neuen Platz für diese oder fehlt mir etwas in meiner Konfiguration?

Plugins.Add(new OpenApiFeature 
{ 
    RouteSummary = { 
     { "/clubs", "Customer club lookups" }, 
     { "/customers", "Customer demographics, receipts and transactions" }, 
     { "/dates", "Fiscal date breakdowns" } 
    } 
}); 

Answer 1

Die SwaggerFeature folgt dem Swagger 1.2 Spezifikation, die die Liste der APIs von ihrer Spezifikation entkoppelt, wo die API Resource Object erlaubt Ihnen eine Beschreibung für eine Sammlung von Routen zu spezifizieren. Die kombinierte Open-API-Spezifikation in der Spezifikation Open API v2.0 entfernte diese Funktion jedoch.

Dies wurde mit Open API Tags ersetzt, die ich für in this commit explizite Unterstützung hinzugefügt haben, wo können Sie Gruppen-Operationen angezeigt werden sollen zusammen den gleichen Tag, zB:

[Tag("clubs")] 
[Route("/clubs", "GET")] 
public class GetClubs {} 

[Tag("clubs")] 
[Route("/clubs/{Id}", "PUT")] 
public class UpdateClub 
{ 
    public int Id { get; set; } 
} 

Anschließend können Sie eine Beschreibung angeben für jeden Tag, wenn die OpenApiFeature, zB Registrierung:

Plugins.Add(new OpenApiFeature 
{ 
    Tags = 
    { 
     new OpenApiTag 
     { 
      Name = "clubs", 
      Description = "Customer club lookups", 
     }, 
     new OpenApiTag 
     { 
      Name = "customers", 
      Description = "Customer demographics, receipts and transactions", 
     }, 
     new OpenApiTag 
     { 
      Name = "dates", 
      Description = "Fiscal date breakdowns", 
     }, 
    } 
}); 

die neue Tags Sammlung von v4.5.13 verfügbar das ist jetzt available on MyGet.