public void Apply(
ApiDescription apiDescription,
OperationSpec operationSpec,
ModelSpecRegistrar modelSpecRegistrar,
ModelSpecGenerator modelSpecGenerator)
{
var responseTypeAttr = apiDescription.ActionDescriptor.GetCustomAttributes<ResponseTypeAttribute>().FirstOrDefault();
if (responseTypeAttr == null) return;
IEnumerable<ModelSpec> complexSpecs;
var modelSpec = modelSpecGenerator.TypeToModelSpec(responseTypeAttr.Type, out complexSpecs);
if (modelSpec.Type == "object")
{
operationSpec.Type = modelSpec.Id;
}
else
{
operationSpec.Type = modelSpec.Type;
operationSpec.Format = modelSpec.Format;
operationSpec.Items = modelSpec.Items;
operationSpec.Enum = modelSpec.Enum;
}
modelSpecRegistrar.RegisterMany(complexSpecs);
}
public OperationSpec ApiDescriptionToOperationSpec(ApiDescription apiDescription, ModelSpecRegistrar modelSpecRegistrar)
{
var apiPath = apiDescription.RelativePathSansQueryString();
var paramSpecs = apiDescription.ParameterDescriptions
.Select(paramDesc => CreateParameterSpec(paramDesc, apiPath, modelSpecRegistrar))
.ToList();
var operationSpec = new OperationSpec
{
Method = apiDescription.HttpMethod.Method,
Nickname = apiDescription.Nickname(),
Summary = apiDescription.Documentation,
Parameters = paramSpecs,
ResponseMessages = new List <ResponseMessageSpec>()
};
var returnType = apiDescription.ActionDescriptor.ReturnType;
if (returnType == null)
{
operationSpec.Type = "void";
}
else
{
IEnumerable <ModelSpec> complexSpecs;
var modelSpec = _modelSpecGenerator.TypeToModelSpec(returnType, out complexSpecs);
modelSpecRegistrar.RegisterMany(complexSpecs);
if (modelSpec.Type == "object")
{
operationSpec.Type = modelSpec.Id;
}
else
{
operationSpec.Type = modelSpec.Type;
operationSpec.Format = modelSpec.Format;
operationSpec.Items = modelSpec.Items;
operationSpec.Enum = modelSpec.Enum;
}
}
foreach (var filter in _operationFilters)
{
filter.Apply(apiDescription, operationSpec, modelSpecRegistrar, _modelSpecGenerator);
}
// IOperationSpecFilter is obsolete - below is for back-compat
var modelSpecMap = new ModelSpecMap(modelSpecRegistrar, _modelSpecGenerator);
foreach (var filter in _operationSpecFilters)
{
filter.Apply(apiDescription, operationSpec, modelSpecMap);
}
return(operationSpec);
}
public OperationSpec ApiDescriptionToOperationSpec(ApiDescription apiDescription, ModelSpecRegistrar modelSpecRegistrar)
{
var apiPath = apiDescription.RelativePathSansQueryString();
var paramSpecs = apiDescription.ParameterDescriptions
.Select(paramDesc => CreateParameterSpec(paramDesc, apiPath, modelSpecRegistrar))
.ToList();
var operationSpec = new OperationSpec
{
Method = apiDescription.HttpMethod.Method,
Nickname = apiDescription.Nickname(),
Summary = apiDescription.Documentation,
Parameters = paramSpecs,
ResponseMessages = new List<ResponseMessageSpec>()
};
var returnType = apiDescription.ActionDescriptor.ReturnType;
if (returnType == null)
{
operationSpec.Type = "void";
}
else
{
IEnumerable<ModelSpec> complexSpecs;
var modelSpec = _modelSpecGenerator.TypeToModelSpec(returnType, out complexSpecs);
modelSpecRegistrar.RegisterMany(complexSpecs);
if (modelSpec.Type == "object")
{
operationSpec.Type = modelSpec.Id;
}
else
{
operationSpec.Type = modelSpec.Type;
operationSpec.Format = modelSpec.Format;
operationSpec.Items = modelSpec.Items;
operationSpec.Enum = modelSpec.Enum;
}
}
foreach (var filter in _operationFilters)
{
filter.Apply(apiDescription, operationSpec, modelSpecRegistrar, _modelSpecGenerator);
}
// IOperationSpecFilter is obsolete - below is for back-compat
var modelSpecMap = new ModelSpecMap(modelSpecRegistrar, _modelSpecGenerator);
foreach (var filter in _operationSpecFilters)
{
filter.Apply(apiDescription, operationSpec, modelSpecMap);
}
return operationSpec;
}
public ModelSpec FindOrCreateFor(Type type)
{
IEnumerable <ModelSpec> complexSpecs;
var modelSpec = _modelSpecGenerator.TypeToModelSpec(type, out complexSpecs);
_modelSpecRegistrar.RegisterMany(complexSpecs);
if (modelSpec.Type == "object")
{
_modelSpecRegistrar.Register(modelSpec);
}
return(modelSpec);
}
private ParameterSpec CreateParameterSpec(ApiParameterDescription apiParamDesc, string apiPath, ModelSpecRegistrar modelSpecRegistrar)
{
var paramType = "";
switch (apiParamDesc.Source)
{
case ApiParameterSource.FromBody:
paramType = "body";
break;
case ApiParameterSource.FromUri:
paramType = apiPath.Contains(String.Format("{{{0}}}", apiParamDesc.Name)) ? "path" : "query";
break;
}
var paramSpec = new ParameterSpec
{
ParamType = paramType,
Name = apiParamDesc.Name,
Description = apiParamDesc.Documentation,
Required = !apiParamDesc.ParameterDescriptor.IsOptional
};
IEnumerable <ModelSpec> complexSpecs;
var modelSpec = _modelSpecGenerator.TypeToModelSpec(apiParamDesc.ParameterDescriptor.ParameterType, out complexSpecs);
modelSpecRegistrar.RegisterMany(complexSpecs);
if (modelSpec.Type == "object")
{
paramSpec.Type = modelSpec.Id;
}
else
{
paramSpec.Type = modelSpec.Type;
paramSpec.Format = modelSpec.Format;
paramSpec.Items = modelSpec.Items;
paramSpec.Enum = modelSpec.Enum;
}
return(paramSpec);
}
private ParameterSpec CreateParameterSpec(ApiParameterDescription apiParamDesc, string apiPath, ModelSpecRegistrar modelSpecRegistrar)
{
var paramType = "";
switch (apiParamDesc.Source)
{
case ApiParameterSource.FromBody:
paramType = "body";
break;
case ApiParameterSource.FromUri:
paramType = apiPath.Contains(String.Format("{{{0}}}", apiParamDesc.Name)) ? "path" : "query";
break;
}
var paramSpec = new ParameterSpec
{
ParamType = paramType,
Name = apiParamDesc.Name,
Description = apiParamDesc.Documentation,
Required = !apiParamDesc.ParameterDescriptor.IsOptional
};
IEnumerable<ModelSpec> complexSpecs;
var modelSpec = _modelSpecGenerator.TypeToModelSpec(apiParamDesc.ParameterDescriptor.ParameterType, out complexSpecs);
modelSpecRegistrar.RegisterMany(complexSpecs);
if (modelSpec.Type == "object")
{
paramSpec.Type = modelSpec.Id;
}
else
{
paramSpec.Type = modelSpec.Type;
paramSpec.Format = modelSpec.Format;
paramSpec.Items = modelSpec.Items;
paramSpec.Enum = modelSpec.Enum;
}
return paramSpec;
}
