/// <summary>
/// Get the resource description of the api for swagger documentation
/// </summary>
/// <remarks>It is very convenient to have this information available for generating clients. This is the entry point for the swagger UI
/// </remarks>
/// <returns>JSON document representing structure of API</returns>
public HttpResponseMessage Get(int type = 1)
{
var docProvider = (XmlCommentDocumentationProvider)GlobalConfiguration.Configuration.Services.GetDocumentationProvider();
ResourceListing r = SwaggerGen.CreateResourceListing(ControllerContext);
List <string> uniqueControllers = new List <string>();
foreach (var api in GlobalConfiguration.Configuration.Services.GetApiExplorer().ApiDescriptions)
{
string controllerName = api.ActionDescriptor.ControllerDescriptor.ControllerName;
if (uniqueControllers.Contains(controllerName) ||
controllerName.ToUpper().Equals(SwaggerGen.SWAGGER.ToUpper()) ||
controllerName.ToLower().StartsWith("abp")
)
{
continue;
}
uniqueControllers.Add(controllerName);
//添加API
ResourceApi rApi = SwaggerGen.CreateResourceApi(api);
r.apis.Add(rApi);
}
HttpResponseMessage resp = new HttpResponseMessage();
resp.Content = new ObjectContent <ResourceListing>(r, ControllerContext.Configuration.Formatters.JsonFormatter);
return(resp);
}
private ResourceListing getDocs(HttpActionContext actionContext)
{
var assemblyType = (actionContext.ActionDescriptor as ReflectedHttpActionDescriptor).MethodInfo.DeclaringType;
var docProvider = new XmlCommentDocumentationProvider(); //(XmlCommentDocumentationProvider)GlobalConfiguration.Configuration.Services.GetDocumentationProvider();
ResourceListing r = SwaggerGen.CreateResourceListing(actionContext);
foreach (var api in GlobalConfiguration.Configuration.Services.GetApiExplorer().ApiDescriptions)
{
if (api.ActionDescriptor.ActionName.EndsWith("API"))//Ignore each Default API action
{
continue;
}
string apiControllerName = api.ActionDescriptor.ControllerDescriptor.ControllerName;
if (api.Route.Defaults.ContainsKey(SwaggerGen.SWAGGER) ||
apiControllerName.ToUpper().Equals(SwaggerGen.SWAGGER.ToUpper()))
{
continue;
}
// Make sure we only report the current controller docs
if (!apiControllerName.Equals(actionContext.ControllerContext.ControllerDescriptor.ControllerName))
{
continue;
}
ResourceApi rApi = SwaggerGen.CreateResourceApi(api);
r.apis.Add(rApi);
ResourceApiOperation rApiOperation = SwaggerGen.CreateResourceApiOperation(r, api, docProvider);
rApi.operations.Add(rApiOperation);
foreach (var param in api.ParameterDescriptions)
{
ResourceApiOperationParameter parameter = SwaggerGen.CreateResourceApiOperationParameter(r, api, param, docProvider);
rApiOperation.parameters.Add(parameter);
}
if (System.Configuration.ConfigurationManager.AppSettings["swagger:APITOKEN"] != null &&
System.Configuration.ConfigurationManager.AppSettings["swagger:APITOKEN"].Equals("true") &&
!api.ActionDescriptor.ActionName.EndsWith("API"))
{
//添加Token
ResourceApiOperationParameter p = new ResourceApiOperationParameter();
p.name = "ApiToken";
p.description = "Api Token";
p.paramType = "path";
p.required = true;
p.dataType = "String";
rApiOperation.parameters.Insert(0, p);
}
SwaggerGen.CreateModel(r, api, docProvider);
//r.models = new ResourceApiModel();
}
return(r);
}
private XPathNavigator GetTypeNode(Type type)
{
string controllerTypeName = GetTypeName(type);
string selectExpression = String.Format(CultureInfo.InvariantCulture, TypeExpression, controllerTypeName);
var doc = SwaggerGen.GetXPathDocument(type);
return(doc == null ? null : doc.SelectSingleNode(selectExpression));
}
private XPathNavigator GetMemberNode(HttpActionDescriptor actionDescriptor)
{
ReflectedHttpActionDescriptor reflectedActionDescriptor = actionDescriptor as ReflectedHttpActionDescriptor;
if (reflectedActionDescriptor != null)
{
string selectExpression = string.Format(_methodExpression, GetMemberName(reflectedActionDescriptor.MethodInfo));
var doc = SwaggerGen.GetXPathDocument(reflectedActionDescriptor.MethodInfo.DeclaringType);
if (doc != null)
{
XPathNavigator node = doc.SelectSingleNode(selectExpression);
if (node != null)
{
return(node);
}
}
}
return(null);
}
