private IEnumerable <SwaggerRouteData> ToSwaggerRouteData(INancyModule module)
{
Func <IEnumerable <RouteAttribute>, RouteId> getRouteId = (attrs) =>
{
return(attrs.Select(attr => RouteId.Create(module, attr))
.FirstOrDefault(routeId => routeId.IsValid));
};
// Discover route handlers and put them in a Dictionary<RouteId, MethodInfo>
var routeHandlers =
module.GetType().GetMethods(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static)
.Select(methodInfo => new
{
RouteId = getRouteId(methodInfo.GetCustomAttributes <RouteAttribute>()),
MethodInfo = methodInfo
})
.Where(x => x.RouteId.IsValid)
.ToDictionary(
x => x.RouteId,
x => x.MethodInfo
);
return(module.Routes
.Select(route => CreateSwaggerRouteData(module, route, routeHandlers)));
}
private SwaggerRouteData CreateSwaggerRouteData(INancyModule module, Route route, Dictionary <RouteId, MethodInfo> routeHandlers)
{
var data = new SwaggerRouteData
{
ApiPath = route.Description.Path,
ResourcePath = module.ModulePath.EnsureForwardSlash(),
OperationMethod = route.Description.Method.ToHttpMethod(),
OperationNickname = route.Description.Name
};
var routeId = RouteId.Create(module, route);
var handler = routeHandlers.ContainsKey(routeId) ? routeHandlers[routeId] : null;
if (handler == null)
{
data.OperationNotes = "[example]"; // TODO: Insert example how to annotate a route
data.OperationSummary = "Warning: no annotated method found for this route";
data.Show = !SwaggerConfig.ShowOnlyAnnotatedRoutes;;
return(data);
}
foreach (var attr in handler.GetCustomAttributes <RouteAttribute>())
{
data.OperationSummary = attr.Summary ?? data.OperationSummary;
data.OperationNotes = attr.Notes ?? data.OperationNotes;
data.OperationModel = attr.Response ?? data.OperationModel;
data.OperationConsumes = attr.Consumes ?? data.OperationConsumes;
data.OperationProduces = attr.Produces ?? data.OperationProduces;
data.Show = attr.Show != NullableBool.False;
}
data.OperationResponseMessages = handler.GetCustomAttributes <SwaggerResponseAttribute>()
.Select(attr => {
var msg = new ResponseMessage
{
Code = (int)attr.Code,
Message = attr.Message
};
if (attr.Model != null)
{
msg.ResponseModel = Primitive.IsPrimitive(attr.Model)
? Primitive.FromType(attr.Model).Type
: SwaggerConfig.ModelIdConvention(attr.Model);
}
return(msg);
})
.ToList();
data.OperationParameters = handler.GetParameters()
.Select(CreateSwaggerParameterData)
.ToList();
return(data);
}
private SwaggerRouteData CreateSwaggerRouteData(INancyModule module, Route route, Dictionary <RouteId, MethodInfo> routeHandlers)
{
var data = new SwaggerRouteData(route.Description.Path, new PathItem());
var routeId = RouteId.Create(module, route);
var handler = routeHandlers.ContainsKey(routeId) ? routeHandlers[routeId] : null;
var operation = new AnnotatedOperation(route.Description.Name, handler, _modelCatalog);
var method = route.Description.Method.ToHttpMethod();
switch (route.Description.Method.ToLowerInvariant())
{
case "get":
data.PathItem.Get = operation;
break;
case "post":
data.PathItem.Post = operation;
break;
case "patch":
data.PathItem.Patch = operation;
break;
case "delete":
data.PathItem.Delete = operation;
break;
case "put":
data.PathItem.Put = operation;
break;
case "head":
data.PathItem.Head = operation;
break;
case "options":
data.PathItem.Options = operation;
break;
}
if (operation.ResponseType != null)
{
data.Types.Add(method, operation.ResponseType);
}
return(data);
}
public static RouteId Create(INancyModule module, RouteAttribute swaggerRouteAttribute)
{
var routeId = new RouteId { Module = module };
if (!string.IsNullOrEmpty(swaggerRouteAttribute.Name))
{
routeId.Name = swaggerRouteAttribute.Name;
}
else if (swaggerRouteAttribute.Path != null)
{
routeId.Method = swaggerRouteAttribute.Method;
routeId.Path = module.ModulePath.EnsureForwardSlash() + swaggerRouteAttribute.Path;
}
return routeId;
}
public static RouteId Create(INancyModule module, Route route)
{
var routeId = new RouteId { Module = module };
if (!string.IsNullOrEmpty(route.Description.Name))
{
routeId.Name = route.Description.Name;
}
else
{
routeId.Method = route.Description.Method.ToHttpMethod();
routeId.Path = route.Description.Path.EnsureForwardSlash();
}
return routeId;
}
public static RouteId Create(INancyModule module, Route route)
{
var routeId = new RouteId {
Module = module
};
if (!string.IsNullOrEmpty(route.Description.Name))
{
routeId.Name = route.Description.Name;
}
else
{
routeId.Method = route.Description.Method.ToHttpMethod();
routeId.Path = route.Description.Path.EnsureForwardSlash();
}
return(routeId);
}
public static RouteId Create(INancyModule module, RouteAttribute swaggerRouteAttribute)
{
var routeId = new RouteId {
Module = module
};
if (!string.IsNullOrEmpty(swaggerRouteAttribute.Name))
{
routeId.Name = swaggerRouteAttribute.Name;
}
else if (swaggerRouteAttribute.Path != null)
{
routeId.Method = swaggerRouteAttribute.Method;
routeId.Path = module.ModulePath.EnsureForwardSlash() + swaggerRouteAttribute.Path;
}
return(routeId);
}
private bool ShowRoute(INancyModule module, Route route, Dictionary <RouteId, MethodInfo> routeHandlers)
{
var routeId = RouteId.Create(module, route);
return(routeHandlers.ContainsKey(routeId) || !SwaggerAnnotationsConfig.ShowOnlyAnnotatedRoutes);
}
private SwaggerRouteData CreateSwaggerRouteData(INancyModule module, Route route, Dictionary <RouteId, MethodInfo> routeHandlers)
{
var operation = new Operation()
{
OperationId = route.Description.Name
};
var data = new SwaggerRouteData(route.Description.Path, new PathItem());
var method = route.Description.Method.ToHttpMethod();
switch (route.Description.Method.ToLowerInvariant())
{
case "get":
data.PathItem.Get = operation;
break;
case "post":
data.PathItem.Post = operation;
break;
case "patch":
data.PathItem.Patch = operation;
break;
case "delete":
data.PathItem.Delete = operation;
break;
case "put":
data.PathItem.Put = operation;
break;
case "head":
data.PathItem.Head = operation;
break;
case "options":
data.PathItem.Options = operation;
break;
}
var routeId = RouteId.Create(module, route);
var handler = routeHandlers.ContainsKey(routeId) ? routeHandlers[routeId] : null;
if (handler == null)
{
operation.Description = "[example]"; // TODO: Insert example how to annotate a route
operation.Summary = "Warning: no annotated method found for this route";
return(data);
}
Type model = null;
foreach (var attr in handler.GetCustomAttributes <RouteAttribute>())
{
operation.Summary = attr.Summary ?? operation.Summary;
operation.Description = attr.Notes ?? operation.Description;
model = attr.Response ?? model;
operation.Consumes = attr.Consumes ?? operation.Consumes;
operation.Consumes = attr.Produces ?? operation.Produces;
}
if (model != null)
{
data.Types.Add(method, model);
}
operation.Responses = handler.GetCustomAttributes <SwaggerResponseAttribute>()
.Select(attr =>
{
var msg = new global::Swagger.ObjectModel.Response()
{
Description = attr.Message
};
//if (attr.Model != null)
//{
// msg.ResponseModel = Primitive.IsPrimitive(attr.Model)
// ? Primitive.FromType(attr.Model).Type
// : SwaggerConfig.ModelIdConvention(attr.Model);
//}
return(Tuple.Create((int)attr.Code, msg));
})
.ToDictionary(x => x.Item1.ToString(), x => x.Item2);
operation.Parameters = handler.GetParameters()
.Select(CreateSwaggerParameterData)
.ToList();
return(data);
}
