Come mostrare WebAPI OAuth endpoint gettone in Swagger

Question

Ho creato un nuovo progetto Web Api, ha aggiunto Asp.Net Identità e OAuth configurato in questo modo:

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

Questo tutto funziona benissimo, posso chiamare il/Endpoint token e ottenere indietro un token al portatore.

Il problema è che questo non è rilevabile in Swagger. Presumo perché non è su un controller e quindi non ha una documentazione xml generata per esso.

Qualcuno sa di un modo per visualizzare questo endpoint di accesso nei miei documenti Swagger?

Grazie.

Inoltre, avrei dovuto dire che la documentazione di Swagger funziona con tutti i miei controller, è solo che mi manca questo metodo ovvio - come accedere.

Answer 1

ApiExplorer non genererà automaticamente alcuna informazione per l'endpoint, quindi sarà necessario aggiungere un DocumentFilter personalizzato per descrivere manualmente l'endpoint del token.

C'è un esempio di questo in 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>(); 
});