1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
|
// Copyright (c) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
using System.Linq;
using System.Web.Http.Controllers;
using System.Web.Http.Description;
namespace System.Web.Http.ApiExplorer
{
public class AttributeDocumentationProvider : IDocumentationProvider
{
public string GetDocumentation(HttpActionDescriptor actionDescriptor)
{
var apiDocumentation = actionDescriptor.GetCustomAttributes<ApiDocumentationAttribute>().FirstOrDefault();
if (apiDocumentation != null)
{
return apiDocumentation.Description;
}
return string.Empty;
}
public string GetDocumentation(HttpParameterDescriptor parameterDescriptor)
{
var parameterDocumentation = parameterDescriptor.ActionDescriptor.GetCustomAttributes<ApiParameterDocumentationAttribute>().FirstOrDefault(param => param.ParameterName == parameterDescriptor.ParameterName);
if (parameterDocumentation != null)
{
return parameterDocumentation.Description;
}
return string.Empty;
}
}
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
public sealed class ApiDocumentationAttribute : Attribute
{
public ApiDocumentationAttribute(string description)
{
Description = description;
}
public string Description { get; private set; }
}
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public sealed class ApiParameterDocumentationAttribute : Attribute
{
public ApiParameterDocumentationAttribute(string parameterName, string description)
{
ParameterName = parameterName;
Description = description;
}
public string ParameterName { get; private set; }
public string Description { get; private set; }
}
}
|