private void ApplyPropertyTags(OpenApiRequestBody requestBody, PropertyInfo propertyInfo)
{
var propertyMemberName = XmlCommentsNodeNameHelper.GetMemberNameForFieldOrProperty(propertyInfo);
var propertySummaryNode = _xmlNavigator.SelectSingleNode($"/doc/members/member[@name='{propertyMemberName}']/summary");
if (propertySummaryNode != null)
{
requestBody.Description = XmlCommentsTextHelper.Humanize(propertySummaryNode.InnerXml);
}
}
private void ApplyTypeTags(OpenApiSchema schema, Type type)
{
var typeMemberName = XmlCommentsNodeNameHelper.GetMemberNameForType(type);
var typeSummaryNode = _xmlNavigator.SelectSingleNode($"/doc/members/member[@name='{typeMemberName}']/summary");
if (typeSummaryNode != null)
{
schema.Description = XmlCommentsTextHelper.Humanize(typeSummaryNode.InnerXml);
}
}
private void ApplyResponsesXmlToResponses(IDictionary <string, OpenApiResponse> responses, XPathNodeIterator responseNodes)
{
while (responseNodes.MoveNext())
{
var code = responseNodes.Current.GetAttribute("code", "");
var response = responses.ContainsKey(code)
? responses[code]
: responses[code] = new OpenApiResponse();
response.Description = XmlCommentsTextHelper.Humanize(responseNodes.Current.InnerXml);
}
}
private void ApplyResponseTags(OpenApiOperation operation, XPathNodeIterator responseNodes)
{
while (responseNodes.MoveNext())
{
var code = responseNodes.Current.GetAttribute("code", "");
var response = operation.Responses.ContainsKey(code)
? operation.Responses[code]
: operation.Responses[code] = new OpenApiResponse();
response.Description = XmlCommentsTextHelper.Humanize(responseNodes.Current.InnerXml);
}
}
private void TryApplyTypeComments(OpenApiSchema schema, Type type)
{
var typeNodeName = XmlCommentsNodeNameHelper.GetMemberNameForType(type);
var typeNode = _xmlNavigator.SelectSingleNode(string.Format(NodeXPath, typeNodeName));
if (typeNode != null)
{
var summaryNode = typeNode.SelectSingleNode(SummaryTag);
if (summaryNode != null)
{
schema.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
}
}
private static void ApplyResponseComments(Operation operation, XPathNavigator methodNode)
{
var responseNodes = methodNode.Select(ResponsesXPath);
while (responseNodes.MoveNext())
{
var responseNode = responseNodes.Current;
var code = responseNode.GetAttribute("code", "");
var response = operation.Responses.ContainsKey(code)
? operation.Responses[code]
: operation.Responses[code] = new Response();
response.Description = XmlCommentsTextHelper.Humanize(responseNode.InnerXml);
}
}
private void ApplyParamTags(OpenApiSchema schema, ParameterInfo parameterInfo)
{
if (!(parameterInfo.Member is MethodInfo methodInfo))
{
return;
}
var methodMemberName = XmlCommentsNodeNameHelper.GetMemberNameForMethod(methodInfo);
var paramNode = _xmlNavigator.SelectSingleNode(
$"/doc/members/member[@name='{methodMemberName}']/param[@name='{parameterInfo.Name}']");
if (paramNode != null)
{
schema.Description = XmlCommentsTextHelper.Humanize(paramNode.InnerXml);
}
}
private void ApplyMethodXmlToOperation(OpenApiOperation operation, XPathNavigator methodNode)
{
var summaryNode = methodNode.SelectSingleNode(SummaryXPath);
if (summaryNode != null)
{
operation.Summary = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
var remarksNode = methodNode.SelectSingleNode(RemarksXPath);
if (remarksNode != null)
{
operation.Description = XmlCommentsTextHelper.Humanize(remarksNode.InnerXml);
}
}
private void ApplyPropertyComments(Schema propertySchema, PropertyInfo propertyInfo)
{
var commentId = XmlCommentsIdHelper.GetCommentIdForProperty(propertyInfo);
var propertyNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, commentId));
if (propertyNode == null)
{
return;
}
var summaryNode = propertyNode.SelectSingleNode(SummaryTag);
if (summaryNode != null)
{
propertySchema.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
}
private void ApplyPropertyComments(Schema propertySchema, MemberInfo memberInfo)
{
var memberName = XmlCommentsMemberNameHelper.GetMemberNameForMember(memberInfo);
var memberNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, memberName));
if (memberNode == null)
{
return;
}
var summaryNode = memberNode.SelectSingleNode(SummaryTag);
if (summaryNode != null)
{
propertySchema.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
}
private void ApplyParamsXmlToActionParameters(
IList <OpenApiParameter> parameters,
OpenApiRequestBody requestBody,
ApiDescription apiDescription,
XPathNavigator methodNode)
{
if (parameters == null)
{
return;
}
foreach (var parameter in parameters)
{
// Check for a corresponding action parameter?
var actionParameter = apiDescription.ActionDescriptor.Parameters
.FirstOrDefault(p => parameter.Name.Equals(
(p.BindingInfo?.BinderModelName ?? p.Name), StringComparison.OrdinalIgnoreCase));
if (actionParameter == null)
{
continue;
}
var paramNode = methodNode.SelectSingleNode(string.Format(ParamXPath, actionParameter.Name));
if (paramNode != null)
{
parameter.Description = XmlCommentsTextHelper.Humanize(paramNode.InnerXml);
}
}
if (requestBody != null)
{
var actionParameter = apiDescription.ParameterDescriptions
.FirstOrDefault(p => p.IsFromBody());
if (actionParameter != null)
{
var paramNode = methodNode.SelectSingleNode(string.Format(ParamXPath, actionParameter.Name));
if (paramNode != null)
{
requestBody.Description = XmlCommentsTextHelper.Humanize(paramNode.InnerXml);
}
}
}
}
private void ApplyParamTags(OpenApiRequestBody requestBody, RequestBodyFilterContext context, ParameterInfo parameterInfo)
{
if (!(parameterInfo.Member is MethodInfo methodInfo))
{
return;
}
// If method is from a constructed generic type, look for comments from the generic type method
var targetMethod = methodInfo.DeclaringType.IsConstructedGenericType
? methodInfo.GetUnderlyingGenericTypeMethod()
: methodInfo;
if (targetMethod == null)
{
return;
}
var methodMemberName = XmlCommentsNodeNameHelper.GetMemberNameForMethod(targetMethod);
var paramNode = _xmlNavigator.SelectSingleNode(
$"/doc/members/member[@name='{methodMemberName}']/param[@name='{parameterInfo.Name}']");
if (paramNode != null)
{
requestBody.Description = XmlCommentsTextHelper.Humanize(paramNode.InnerXml);
var example = paramNode.GetAttribute("example", "");
if (string.IsNullOrEmpty(example))
{
return;
}
foreach (var mediaType in requestBody.Content.Values)
{
var exampleAsJson = (mediaType.Schema?.ResolveType(context.SchemaRepository) == "string")
? $"\"{example}\""
: example;
mediaType.Example = OpenApiAnyFactory.CreateFromJson(exampleAsJson);
}
}
}
private void ApplyPropertiesXmlToPropertyParameters(
IList <OpenApiParameter> parameters,
ApiDescription apiDescription)
{
if (parameters == null)
{
return;
}
foreach (var parameter in parameters)
{
// Check for a corresponding API parameter (from ApiExplorer) that's property-bound?
var propertyParam = apiDescription.ParameterDescriptions
.Where(p => p.ModelMetadata?.ContainerType != null && p.ModelMetadata?.PropertyName != null)
.FirstOrDefault(p => parameter.Name.Equals(p.Name, StringComparison.OrdinalIgnoreCase));
if (propertyParam == null)
{
continue;
}
var metadata = propertyParam.ModelMetadata;
var memberInfo = metadata.ContainerType.GetMember(metadata.PropertyName).FirstOrDefault();
if (memberInfo == null)
{
continue;
}
var memberName = XmlCommentsNodeNameHelper.GetNodeNameForMember(memberInfo);
var memberNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, memberName));
if (memberNode == null)
{
continue;
}
var summaryNode = memberNode.SelectSingleNode(SummaryXPath);
if (summaryNode != null)
{
parameter.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
}
}
public void Apply(Schema schema, SchemaFilterContext context)
{
var jsonObjectContract = context.JsonContract as JsonObjectContract;
if (jsonObjectContract == null)
{
return;
}
var commentId = XmlCommentsIdHelper.GetCommentIdForType(context.SystemType);
var typeNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, commentId));
if (typeNode != null)
{
var summaryNode = typeNode.SelectSingleNode(SummaryTag);
if (summaryNode != null)
{
schema.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
}
if (schema.Properties == null)
{
return;
}
foreach (var entry in schema.Properties)
{
var jsonProperty = jsonObjectContract.Properties[entry.Key];
if (jsonProperty == null)
{
continue;
}
var propertyInfo = jsonProperty.PropertyInfo();
if (propertyInfo != null)
{
ApplyPropertyComments(entry.Value, propertyInfo);
}
}
}
private void ApplyParamTags(OpenApiSchema schema, ParameterInfo parameterInfo)
{
if (!(parameterInfo.Member is MethodInfo methodInfo))
{
return;
}
var methodMemberName = XmlCommentsNodeNameHelper.GetMemberNameForMethod(methodInfo);
var paramNode = _xmlNavigator.SelectSingleNode(
$"/doc/members/member[@name='{methodMemberName}']/param[@name='{parameterInfo.Name}']");
if (paramNode != null)
{
schema.Description = XmlCommentsTextHelper.Humanize(paramNode.InnerXml);
var example = paramNode.GetAttribute("example", "");
if (!string.IsNullOrEmpty(example))
{
schema.Example = ConvertToOpenApiType(parameterInfo.ParameterType, schema, example);
}
}
}
public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
var jsonObjectContract = context.JsonContract as JsonObjectContract;
if (jsonObjectContract == null)
{
return;
}
var memberName = XmlCommentsMemberNameHelper.GetMemberNameForType(context.Type);
var typeNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, memberName));
if (typeNode != null)
{
var summaryNode = typeNode.SelectSingleNode(SummaryTag);
if (summaryNode != null)
{
schema.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
}
if (schema.Properties == null)
{
return;
}
foreach (var entry in schema.Properties)
{
var jsonProperty = jsonObjectContract.Properties[entry.Key];
if (jsonProperty == null)
{
continue;
}
if (jsonProperty.TryGetMemberInfo(out MemberInfo memberInfo))
{
ApplyPropertyComments(entry.Value, memberInfo);
}
}
}
private void ApplyPropertyTags(OpenApiParameter parameter, PropertyInfo propertyInfo)
{
var propertyMemberName = XmlCommentsNodeNameHelper.GetMemberNameForFieldOrProperty(propertyInfo);
var propertyNode = _xmlNavigator.SelectSingleNode($"/doc/members/member[@name='{propertyMemberName}']");
if (propertyNode == null)
{
return;
}
var summaryNode = propertyNode.SelectSingleNode("summary");
if (summaryNode != null)
{
parameter.Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml);
}
var exampleNode = propertyNode.SelectSingleNode("example");
if (exampleNode != null)
{
parameter.Example = OpenApiAnyFactory.CreateFromJson(exampleNode.InnerXml);
}
}
