документация для включения интеграции XmlDoc в ваш веб-API. Кажется, что проекты обрабатывают только ситуации, когда все ваши типы API являются частью вашего проекта WebApi. В частности, обсуждается, как перенаправить XML-документацию на App_Data/XmlDocument.xml
и раскомментировать строку в вашей конфигурации, которая будет использовать этот файл. Это неявно разрешает только один файл документации проекта.
Однако в моей настройке типы запросов и ответов определены в общем проекте «Модели». Это означает, что если у меня определена конечная точка, например:
[Route("auth/openid/login")]
public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... }
Где OpenIdLoginRequest
определен в отдельном проекте C # следующим образом:
public class OpenIdLoginRequest
{
/// <summary>
/// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.)
/// </summary>
[Required]
public string Provider { get; set; }
...
}
Несмотря на комментарии XML, свойства параметра request
не содержат документации, когда вы просматриваете страницу справки для конкретной конечной точки (т. Е. http://localhost/Help/Api/POST-auth-openid-login
).
Как я могу сделать так, чтобы типы в подпроектах с XML-документацией отображались в XML-документации Web API?