|
public GetOrRegister ( |
||
| type | ||
| return | ||
private Parameter CreateParameter(string location, ApiParameterDescription paramDesc, SchemaRegistry schemaRegistry)
{
var parameter = new Parameter
{
@in = location,
name = paramDesc.Name
};
if (paramDesc.ParameterDescriptor == null)
{
parameter.type = "string";
parameter.required = true;
return(parameter);
}
parameter.required = location == "path" || !paramDesc.ParameterDescriptor.IsOptional;
parameter.@default = paramDesc.ParameterDescriptor.DefaultValue;
var schema = schemaRegistry.GetOrRegister(paramDesc.ParameterDescriptor.ParameterType);
if (parameter.@in == "body")
{
parameter.schema = schema;
}
else
{
parameter.PopulateFrom(schema);
}
return(parameter);
}
private Parameter CreateParameter(ApiParameterDescription paramDesc, bool inPath, SchemaRegistry schemaRegistry)
{
var @in = (inPath)
? "path"
: (paramDesc.Source == ApiParameterSource.FromUri) ? "query" : "body";
var parameter = new Parameter
{
name = paramDesc.Name,
@in = @in
};
if (paramDesc.ParameterDescriptor == null)
{
parameter.type = "string";
parameter.required = true;
return(parameter);
}
parameter.required = !paramDesc.ParameterDescriptor.IsOptional;
var schema = schemaRegistry.GetOrRegister(paramDesc.ParameterDescriptor.ParameterType);
if (parameter.@in == "body")
{
parameter.schema = schema;
}
else
{
parameter.PopulateFrom(schema);
}
return(parameter);
}
private Parameter CreateParameter(
string location,
ApiParameterDescription paramDesc,
SchemaRegistry schemaRegistry)
{
Parameter partialSchema = new Parameter()
{
@in = location,
name = paramDesc.get_Name()
};
if (paramDesc.get_ParameterDescriptor() == null)
{
partialSchema.type = "string";
partialSchema.required = new bool?(true);
return(partialSchema);
}
partialSchema.required = new bool?(location == "path" || !paramDesc.get_ParameterDescriptor().get_IsOptional());
partialSchema.@default = paramDesc.get_ParameterDescriptor().get_DefaultValue();
Schema orRegister = schemaRegistry.GetOrRegister(paramDesc.get_ParameterDescriptor().get_ParameterType());
if (partialSchema.@in == "body")
{
partialSchema.schema = orRegister;
}
else
{
partialSchema.PopulateFrom(orRegister);
}
return(partialSchema);
}
private Operation CreateOperation(ApiDescription apiDescription, SchemaRegistry schemaRegistry)
{
var parameters = apiDescription.ParameterDescriptions
.Select(paramDesc =>
{
var inPath = apiDescription.RelativePathSansQueryString().Contains("{" + paramDesc.Name + "}");
return(CreateParameter(paramDesc, inPath, schemaRegistry));
})
.ToList();
//parameters.Add(new Parameter()
//{
// @in = "header",
// description = "Custom header values",
// ignore = false,
// name = "SomeHeaderValue",
// schema = new Schema()
// {
// type = "array",
// // items = new Schema() { type = "string" }
// }
//});
var responses = new Dictionary <string, Response>();
var responseType = apiDescription.ResponseType();
if (responseType == null || responseType == typeof(void))
{
responses.Add("204", new Response {
description = "No Content"
});
}
else
{
responses.Add("200", new Response {
description = "OK", schema = schemaRegistry.GetOrRegister(responseType)
});
}
var operation = new Operation
{
tags = new[] { _options.GroupingKeySelector(apiDescription) },
operationId = apiDescription.FriendlyId(),
// customRouteName = apiDescription.GetSwaggerRouteName(),
produces = apiDescription.Produces().ToList(),
consumes = apiDescription.Consumes().ToList(),
parameters = parameters.Any() ? parameters : null, // parameters can be null but not empty
responses = responses,
deprecated = apiDescription.IsObsolete()
};
foreach (var filter in _options.OperationFilters)
{
filter.Apply(operation, schemaRegistry, apiDescription);
}
return(operation);
}
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
var errorSchema = schemaRegistry.GetOrRegister(typeof(HttpError));
operation.responses.Add("200", new Response
{
description = "Ok",
schema = errorSchema
});
}
private Parameter CreateParameter(ApiParameterDescription paramDesc, bool inPath, SchemaRegistry schemaRegistry)
{
var @in = (inPath)
? "path"
: (paramDesc.Source == ApiParameterSource.FromUri) ? "query" : "body";
var parameter = new Parameter
{
name = paramDesc.Name,
@in = @in
};
if (paramDesc.ParameterDescriptor == null)
{
parameter.type = "string";
parameter.required = true;
return(parameter);
}
parameter.required = inPath || !paramDesc.ParameterDescriptor.IsOptional;
parameter.@default = paramDesc.ParameterDescriptor.DefaultValue;
var schema = schemaRegistry.GetOrRegister(paramDesc.ParameterDescriptor.ParameterType);
var reflectedDescriptor = (ReflectedHttpParameterDescriptor)paramDesc.ParameterDescriptor;
foreach (var attribute in reflectedDescriptor.ParameterInfo.GetCustomAttributes(true))
{
SchemaExtensions.SetSchemaDetails(schema, attribute);
}
//if (paramDesc.ParameterDescriptor.ActionDescriptor != null)
//{
// var actionIgnore = paramDesc.ParameterDescriptor.ActionDescriptor.GetCustomAttributes<SwaggerIgnore>();
// if (actionIgnore != null)
// {
// parameter.ignore = true;
// }
//}
if (parameter.@in == "body")
{
parameter.schema = schema;
}
else
{
parameter.PopulateFrom(schema);
}
return(parameter);
}
/// <summary>
/// Apply function
/// </summary>
/// <param name="operation"></param>
/// <param name="schemaRegistry"></param>
/// <param name="apiDescription"></param>
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
var errorSchema = schemaRegistry.GetOrRegister(typeof(ErrorModel));
var err = ErrorModel.Create(Guid.NewGuid(), ErrorCode.Unknown,
"A more technical error message", "A more user friendly error message");
err.SetSystem("ApiName");
// appends a error model to each given error code
foreach (var response in operation.responses.Where(response => !response.Key.StartsWith("2")))
{
response.Value.schema = errorSchema;
response.Value.examples = err;
}
}
private Operation CreateOperation(ApiDescription apiDesc, SchemaRegistry schemaRegistry)
{
var parameters = apiDesc.ParameterDescriptions
.Where(paramDesc =>
{
var paramDescriptor = paramDesc.ParameterDescriptor;
return(paramDescriptor == null || paramDescriptor.ParameterType != typeof(CancellationToken));
})
.Select(paramDesc =>
{
string location = GetParameterLocation(apiDesc, paramDesc);
return(CreateParameter(location, paramDesc, schemaRegistry));
})
.ToList();
var responses = new Dictionary <string, Response>();
var responseType = apiDesc.ResponseType();
if (responseType == null || responseType == typeof(void))
{
responses.Add("204", new Response {
description = "No Content"
});
}
else
{
responses.Add("200", new Response {
description = "OK", schema = schemaRegistry.GetOrRegister(responseType)
});
}
var operation = new Operation
{
tags = new[] { _options.GroupingKeySelector(apiDesc) },
operationId = apiDesc.FriendlyId(),
produces = apiDesc.Produces().ToList(),
consumes = apiDesc.Consumes().ToList(),
parameters = parameters.Any() ? parameters : null, // parameters can be null but not empty
responses = responses,
deprecated = apiDesc.IsObsolete() ? true : (bool?)null
};
foreach (var filter in _options.OperationFilters)
{
filter.Apply(operation, schemaRegistry, apiDesc);
}
return(operation);
}
/// <summary>
/// Apply function
/// </summary>
/// <param name="operation"></param>
/// <param name="schemaRegistry"></param>
/// <param name="apiDescription"></param>
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
var attributes =
apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<WiboriAuthorizeAttribute>()
.ToList();
var actionAttributes =
apiDescription.ActionDescriptor.GetCustomAttributes<WiboriAuthorizeAttribute>()
.ToList();
var authorizeAttributes =
apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<AuthorizeAttribute>()
.ToList();
var authorizeActionAttributes =
apiDescription.ActionDescriptor.GetCustomAttributes<AuthorizeAttribute>()
.ToList();
attributes.AddRange(actionAttributes);
authorizeAttributes.AddRange(authorizeActionAttributes);
if (!attributes.Any() && !authorizeAttributes.Any())
{
return;
}
operation.parameters = operation.parameters ?? new List<Parameter>();
operation.parameters.Add(new Parameter
{
@in = "header",
name = "Authorization",
description = "OAuth2 bearer token",
type = "string",
required = true
});
if (!operation.responses.ContainsKey("401"))
{
var errorSchema = schemaRegistry.GetOrRegister(typeof(ErrorModel));
operation.responses.Add("401", new Response
{
description = "The bearer token in header Authorization is either invalid or has expired.",
schema = errorSchema
});
}
}
private Operation CreateOperation(ApiDescription apiDescription, SchemaRegistry schemaRegistry)
{
var parameters = apiDescription.ParameterDescriptions
.Select(paramDesc =>
{
var inPath = apiDescription.RelativePathSansQueryString().Contains("{" + paramDesc.Name + "}");
return(CreateParameter(paramDesc, inPath, schemaRegistry));
})
.ToList();
var responses = new Dictionary <string, Response>();
var responseType = apiDescription.ResponseType();
if (responseType == null)
{
responses.Add("204", new Response {
description = "No Content"
});
}
else
{
responses.Add("200", new Response {
description = "OK", schema = schemaRegistry.GetOrRegister(responseType)
});
}
var operation = new Operation
{
tags = new [] { _options.GroupingKeySelector(apiDescription) },
operationId = apiDescription.FriendlyId(),
produces = apiDescription.Produces().ToList(),
consumes = apiDescription.Consumes().ToList(),
parameters = parameters.Any() ? parameters : null, // parameters can be null but not empty
responses = responses,
deprecated = apiDescription.IsObsolete()
};
foreach (var filter in _options.OperationFilters)
{
filter.Apply(operation, schemaRegistry, apiDescription);
}
return(operation);
}
private void HandleFromUriObjectParams(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
var fromUriObjectParams = operation.parameters
.Where(param => param.@in == "query" && param.type == null)
.ToArray();
foreach (var objectParam in fromUriObjectParams)
{
var type = apiDescription.ParameterDescriptions
.Single(paramDesc => paramDesc.Name == objectParam.name)
.ParameterDescriptor.ParameterType;
var refSchema = schemaRegistry.GetOrRegister(type);
var schema = schemaRegistry.Definitions[[email protected]("#/definitions/", "")];
ExtractAndAddQueryParams(schema, "", objectParam.required, schemaRegistry, operation.parameters);
operation.parameters.Remove(objectParam);
}
}
private Operation CreateOperation(
ApiDescription apiDesc,
SchemaRegistry schemaRegistry)
{
List <Parameter> list = ((IEnumerable <ApiParameterDescription>)apiDesc.get_ParameterDescriptions()).Select <ApiParameterDescription, Parameter>((Func <ApiParameterDescription, Parameter>)(paramDesc => this.CreateParameter(this.GetParameterLocation(apiDesc, paramDesc), paramDesc, schemaRegistry))).ToList <Parameter>();
Dictionary <string, Response> dictionary = new Dictionary <string, Response>();
Type type = apiDesc.ResponseType();
if (type == (Type)null || type == typeof(void))
{
dictionary.Add("204", new Response()
{
description = "No Content"
});
}
else
{
dictionary.Add("200", new Response()
{
description = "OK",
schema = schemaRegistry.GetOrRegister(type)
});
}
Operation operation = new Operation()
{
tags = (IList <string>) new string[1]
{
this._options.GroupingKeySelector(apiDesc)
},
operationId = apiDesc.FriendlyId(),
produces = (IList <string>)apiDesc.Produces().ToList <string>(),
consumes = (IList <string>)apiDesc.Consumes().ToList <string>(),
parameters = list.Any <Parameter>() ? (IList <Parameter>)list : (IList <Parameter>)null,
responses = (IDictionary <string, Response>)dictionary,
deprecated = apiDesc.IsObsolete() ? new bool?(true) : new bool?()
};
foreach (IOperationFilter operationFilter in this._options.OperationFilters)
{
operationFilter.Apply(operation, schemaRegistry, apiDesc);
}
return(operation);
}
private static void RegisterReferencedTypes(SchemaRegistry registry, IEdmModel edmModel, Schema schema)
{
Contract.Requires(registry != null);
Contract.Requires(schema != null);
while (true)
{
Contract.Assume(schema != null);
var referencedType = schema.GetReferencedType();
if (referencedType != null)
{
registry.GetOrRegister(referencedType);
FixSchemaReference(registry, schema, referencedType);
ApplyEdmModelPropertyNamesToSchema(registry, edmModel, referencedType);
return;
}
if (schema.properties != null && schema.properties.Any())
{
foreach (var property in schema.properties)
{
RegisterReferencedTypes(registry, edmModel, property.Value);
}
return;
}
if (schema.items != null)
{
schema = schema.items;
continue;
}
break;
}
}
private Parameter CreateParameter(ApiParameterDescription paramDesc, bool inPath, SchemaRegistry schemaRegistry)
{
var @in = (inPath)
? "path"
: (paramDesc.Source == ApiParameterSource.FromUri) ? "query" : "body";
var parameter = new Parameter
{
name = paramDesc.Name,
@in = @in
};
if (paramDesc.ParameterDescriptor == null)
{
parameter.type = "string";
parameter.required = true;
return parameter;
}
parameter.required = !paramDesc.ParameterDescriptor.IsOptional;
var schema = schemaRegistry.GetOrRegister(paramDesc.ParameterDescriptor.ParameterType);
if (parameter.@in == "body")
parameter.schema = schema;
else
parameter.PopulateFrom(schema);
return parameter;
}
private Operation CreateOperation(ApiDescription apiDescription, SchemaRegistry schemaRegistry)
{
var parameters = apiDescription.ParameterDescriptions
.Select(paramDesc =>
{
var inPath = apiDescription.RelativePathSansQueryString().Contains("{" + paramDesc.Name + "}");
return CreateParameter(paramDesc, inPath, schemaRegistry);
})
.ToList();
var responses = new Dictionary<string, Response>();
var responseType = apiDescription.ResponseType();
if (responseType == null)
responses.Add("204", new Response { description = "No Content" });
else
responses.Add("200", new Response { description = "OK", schema = schemaRegistry.GetOrRegister(responseType) });
var operation = new Operation
{
tags = new [] { _options.GroupingKeySelector(apiDescription) },
operationId = apiDescription.FriendlyId(),
produces = apiDescription.Produces().ToList(),
consumes = apiDescription.Consumes().ToList(),
parameters = parameters.Any() ? parameters : null, // parameters can be null but not empty
responses = responses,
deprecated = apiDescription.IsObsolete()
};
foreach (var filter in _options.OperationFilters)
{
filter.Apply(operation, schemaRegistry, apiDescription);
}
return operation;
}
/// <summary>
/// Ensures that the 200 response message schmea is present with the correct
/// type and that the 202 response message schema is cleared out
/// </summary>
/// <param name="operation">Metadata for the polling operation of a polling trigger</param>
/// <param name="pollingResponseType">Type of the polling response</param>
/// <param name="schemaRegistry">Current registry of schemas used in the metadata</param>
private static void applyResponseSchemas(Operation operation, Type pollingResponseType, SchemaRegistry schemaRegistry)
{
if (operation.responses == null) operation.responses = new Dictionary<string, Response>();
if (!operation.responses.ContainsKey(Constants.HAPPY_POLL_NO_DATA_RESPONSE_CODE))
{
operation.responses.Add(Constants.HAPPY_POLL_NO_DATA_RESPONSE_CODE, new Response()
{
description = "Successful poll, but no data available"
});
}
operation.responses[Constants.HAPPY_POLL_NO_DATA_RESPONSE_CODE].schema = null;
if (!operation.responses.ContainsKey(Constants.HAPPY_POLL_WITH_DATA_RESPONSE_CODE))
{
operation.responses.Add(Constants.HAPPY_POLL_WITH_DATA_RESPONSE_CODE, new Response()
{
description = "Successful poll with data available"
});
}
operation.responses[Constants.HAPPY_POLL_WITH_DATA_RESPONSE_CODE].schema
= pollingResponseType == null ? null : schemaRegistry.GetOrRegister(pollingResponseType);
}
private Parameter CreateParameter(ApiParameterDescription paramDesc, bool inPath, SchemaRegistry schemaRegistry)
{
var @in = (inPath)
? "path"
: (paramDesc.Source == ApiParameterSource.FromUri) ? "query" : "body";
var parameter = new Parameter
{
name = paramDesc.Name,
@in = @in
};
if (paramDesc.ParameterDescriptor == null)
{
parameter.type = "string";
parameter.required = true;
return parameter;
}
parameter.required = inPath || !paramDesc.ParameterDescriptor.IsOptional;
parameter.@default = paramDesc.ParameterDescriptor.DefaultValue;
var schema = schemaRegistry.GetOrRegister(paramDesc.ParameterDescriptor.ParameterType);
var reflectedDescriptor = (ReflectedHttpParameterDescriptor)paramDesc.ParameterDescriptor;
foreach (var attribute in reflectedDescriptor.ParameterInfo.GetCustomAttributes(true))
{
SchemaExtensions.SetSchemaDetails(schema, attribute);
}
//if (paramDesc.ParameterDescriptor.ActionDescriptor != null)
//{
// var actionIgnore = paramDesc.ParameterDescriptor.ActionDescriptor.GetCustomAttributes<SwaggerIgnore>();
// if (actionIgnore != null)
// {
// parameter.ignore = true;
// }
//}
if (parameter.@in == "body")
parameter.schema = schema;
else
parameter.PopulateFrom(schema);
return parameter;
}
private static Schema HandleGenericODataTypeThatShouldBeUnwrapped(SchemaRegistry registry, IEdmModel edmModel, Type type)
{
var genericArguments = type.GetGenericArguments();
Contract.Assume(genericArguments != null);
var schema = registry.GetOrRegister(genericArguments[0]);
ApplyEdmModelPropertyNamesToSchema(registry, edmModel, genericArguments[0]);
return schema;
}
private static void ApplyEdmModelPropertyNamesToSchema(SchemaRegistry registry, IEdmModel edmModel, Type type)
{
var entityReference = registry.GetOrRegister(type);
if (entityReference.@ref != null)
{
var definitionKey = [email protected]("#/definitions/", string.Empty);
var schemaDefinition = registry.Definitions[definitionKey];
var edmType = edmModel.GetEdmType(type) as IEdmStructuredType;
if (edmType != null)
{
var edmProperties = new Dictionary<string, Schema>();
foreach (var property in schemaDefinition.properties)
{
var currentProperty = type.GetProperty(property.Key, BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance);
var edmPropertyName = GetEdmPropertyName(currentProperty, edmType);
if (edmPropertyName != null)
{
edmProperties.Add(edmPropertyName, property.Value);
}
}
schemaDefinition.properties = edmProperties;
}
}
}
private Parameter CreateParameter(string location, ApiParameterDescription paramDesc, SchemaRegistry schemaRegistry)
{
var parameter = new Parameter
{
@in = location,
name = paramDesc.Name
};
if (paramDesc.ParameterDescriptor == null)
{
parameter.type = "string";
parameter.required = true;
return parameter;
}
parameter.required = location == "path" || !paramDesc.ParameterDescriptor.IsOptional;
parameter.@default = paramDesc.ParameterDescriptor.DefaultValue;
var schema = schemaRegistry.GetOrRegister(paramDesc.ParameterDescriptor.ParameterType);
if (parameter.@in == "body")
parameter.schema = schema;
else
parameter.PopulateFrom(schema);
return parameter;
}
private Operation CreateOperation(ApiDescription apiDesc, SchemaRegistry schemaRegistry)
{
var parameters = apiDesc.ParameterDescriptions
.Select(paramDesc =>
{
string location = GetParameterLocation(apiDesc, paramDesc);
return CreateParameter(location, paramDesc, schemaRegistry);
})
.ToList();
var responses = new Dictionary<string, Response>();
var responseType = apiDesc.ResponseType();
if (responseType == null || responseType == typeof(void))
responses.Add("204", new Response { description = "No Content" });
else
responses.Add("200", new Response { description = "OK", schema = schemaRegistry.GetOrRegister(responseType) });
var operation = new Operation
{
tags = new [] { _options.GroupingKeySelector(apiDesc) },
operationId = apiDesc.FriendlyId(),
produces = apiDesc.Produces().ToList(),
consumes = apiDesc.Consumes().ToList(),
parameters = parameters.Any() ? parameters : null, // parameters can be null but not empty
responses = responses,
deprecated = apiDesc.IsObsolete()
};
foreach (var filter in _options.OperationFilters)
{
filter.Apply(operation, schemaRegistry, apiDesc);
}
return operation;
}
