public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context) { // Collect (unique) controller names and types in a dictionary var controllerNamesAndTypes = context.ApiDescriptions .Select(apiDesc => apiDesc.ActionDescriptor as ControllerActionDescriptor) .SkipWhile(actionDesc => actionDesc == null) .GroupBy(actionDesc => actionDesc.ControllerName) .Select(group => new KeyValuePair <string, Type>(group.Key, group.First().ControllerTypeInfo.AsType())); foreach (var nameAndType in controllerNamesAndTypes) { var memberName = XmlCommentsMemberNameHelper.GetMemberNameForType(nameAndType.Value); var typeNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, memberName)); if (typeNode != null) { var summaryNode = typeNode.SelectSingleNode(SummaryTag); if (summaryNode != null) { if (swaggerDoc.Tags == null) { swaggerDoc.Tags = new List <OpenApiTag>(); } swaggerDoc.Tags.Add(new OpenApiTag { Name = nameAndType.Key, Description = XmlCommentsTextHelper.Humanize(summaryNode.InnerXml) }); } } } }
public void Apply(OpenApiOperation operation, OperationFilterContext context) { if (context.MethodInfo == null) { return; } // If method is from a constructed generic type, look for comments from the generic type method var targetMethod = context.MethodInfo.DeclaringType.IsConstructedGenericType ? GetGenericTypeMethodOrNullFor(context.MethodInfo) : context.MethodInfo; if (targetMethod == null) { return; } var typeMemberName = XmlCommentsMemberNameHelper.GetMemberNameForType(targetMethod.DeclaringType); var typeNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, typeMemberName)); // Apply controller-level tags if any if (typeNode != null) { ApplyResponsesXmlToResponses(operation.Responses, typeNode.Select(ResponsesXPath)); } var methodMemberName = XmlCommentsMemberNameHelper.GetMemberNameForMethod(targetMethod); var methodNode = _xmlNavigator.SelectSingleNode(string.Format(MemberXPath, methodMemberName)); // Apply method-level tags if (methodNode != null) { ApplyMethodXmlToOperation(operation, methodNode); ApplyParamsXmlToActionParameters(operation.Parameters, operation.RequestBody, context.ApiDescription, methodNode); ApplyResponsesXmlToResponses(operation.Responses, methodNode.Select(ResponsesXPath)); // will override controller-level response tags } // Special handling for parameters that are bound to model properties ApplyPropertiesXmlToPropertyParameters(operation.Parameters, context.ApiDescription); }
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) { if (!jsonObjectContract.Properties.Contains(entry.Key)) { continue; } var jsonProperty = jsonObjectContract.Properties[entry.Key]; if (jsonProperty.TryGetMemberInfo(out MemberInfo memberInfo)) { ApplyPropertyComments(entry.Value, memberInfo); } } }