Как показать WebAPI OAuth маркер конечной точки в Swagger

Question

Я создал новый проект Web Api, добавлена ​​Asp.Net Идентичность и сконфигурированный OAuth так:

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

Это все работает отлично, я могу назвать/Конечная точка маркера и вернуть токер-носитель.

Проблема в том, что это невозможно обнаружить в Swagger. Я предполагаю, что он не находится на контроллере и поэтому не имеет XML-документации, сгенерированной для него.

Кто-нибудь знает способ отображения этой конечной точки входа в моих документах Swagger?

Спасибо.

Кроме того, я должен был сказать, что документация Swagger работает со всеми моими контроллерами, просто я пропустил этот один очевидный метод - как войти в систему.

Answer 1

ApiExplorer не будет автоматически генерировать информацию для вашей конечной точки, поэтому вам нужно будет добавить собственный DocumentFilter, чтобы вручную описать конечную точку маркера.

Там пример этого в 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>(); 
});