Wie WebAPI OAuth-Token-Endpunkt in Swagger zeigen

Question

ich ein neues Web-Api-Projekt erstellt haben, hinzugefügt Asp.Net Identität und konfiguriert OAuth wie so:

OAuthOptions = new OAuthAuthorizationServerOptions 
{ 
    TokenEndpointPath = new PathString("/Token"), 
    Provider = new ApplicationOAuthProvider(PublicClientId), 
    AuthorizeEndpointPath = new PathString("/api/Account/ExternalLogin"), 
    AccessTokenExpireTimeSpan = TimeSpan.FromDays(14), 
    AllowInsecureHttp = true 
}; 

Das alles funktioniert gut, ich kann das Gespräch/Token-Endpunkt und holen Sie sich ein Bearer-Token zurück.

Das Problem ist, dass dies nicht in Swagger erkennbar ist, nehme ich an, weil es nicht auf einem Controller ist und daher keine xml-Dokumentation dafür generiert hat.

Kennt jemand eine Möglichkeit, diesen Login-Endpunkt in meinen Swagger-Dokumenten anzuzeigen?

Danke.

Außerdem hätte ich sagen sollen, dass die Swagger-Dokumentation mit all meinen Controllern funktioniert, nur dass mir diese eine offensichtliche Methode fehlt - wie man sich anmeldet.

Answer 1

ApiExplorer generiert keine Informationen automatisch für Ihren Endpunkt, daher müssen Sie einen benutzerdefinierten DocumentFilter hinzufügen, um den Token-Endpunkt manuell zu beschreiben.

Es ist ein Beispiel dafür an https://github.com/domaindrivendev/Swashbuckle/issues/332:

class AuthTokenOperation : IDocumentFilter 
{ 
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer) 
    { 
     swaggerDoc.paths.Add("/auth/token", new PathItem 
     { 
      post = new Operation 
      { 
       tags = new List<string> { "Auth" }, 
       consumes = new List<string> 
       { 
        "application/x-www-form-urlencoded" 
       }, 
       parameters = new List<Parameter> { 
        new Parameter 
        { 
         type = "string", 
         name = "grant_type", 
         required = true, 
         @in = "formData" 
        }, 
        new Parameter 
        { 
         type = "string", 
         name = "username", 
         required = false, 
         @in = "formData" 
        }, 
        new Parameter 
        { 
         type = "string", 
         name = "password", 
         required = false, 
         @in = "formData" 
        } 
       } 
      } 
     }); 
    } 
} 

httpConfig.EnableSwagger(c => 
{ 
    c.DocumentFilter<AuthTokenOperation>(); 
});