public string Create(IOpenApiMetadataResourceStrategy resourceStrategy, OpenApiMetadataDocumentContext documentContext)
{
try
{
var parametersFactory = new OpenApiMetadataParametersFactory(_defaultPageSizeLimitProvider);
var definitionsFactory =
OpenApiMetadataDocumentFactoryHelper.CreateOpenApiMetadataDefinitionsFactory(documentContext);
var responsesFactory = new OpenApiMetadataResponsesFactory();
var pathsFactory =
OpenApiMetadataDocumentFactoryHelper.CreateOpenApiMetadataPathsFactory(
documentContext, _apiSettings);
var tagsFactory =
OpenApiMetadataDocumentFactoryHelper.CreateOpenApiMetadataTagsFactory(documentContext);
var resources = resourceStrategy.GetFilteredResources(documentContext)
.ToList();
var openApiMetadataDocument = new OpenApiMetadataDocument
{
info = new Info
{
title = "Ed-Fi Operational Data Store API",
version = $"{ApiVersionConstants.Ods}",
description =
"The Ed-Fi ODS / API enables applications to read and write education data stored in an Ed-Fi ODS through a secure REST interface. \n***\n > *Note: Consumers of ODS / API information should sanitize all data for display and storage. The ODS / API provides reasonable safeguards against cross-site scripting attacks and other malicious content, but the platform does not and cannot guarantee that the data it contains is free of all potentially harmful content.* \n***\n"
},
host = "%HOST%",
basePath = "%BASE_PATH%",
securityDefinitions =
new Dictionary <string, SecurityScheme>
{
{
"oauth2_client_credentials", new SecurityScheme
{
type = "oauth2",
description =
"Ed-Fi ODS/API OAuth 2.0 Client Credentials Grant Type authorization",
flow = "application",
tokenUrl = "%TOKEN_URL%",
scopes = new Dictionary <string, string>()
}
}
},
security =
new List <IDictionary <string, IEnumerable <string> > >
{
new Dictionary <string, IEnumerable <string> > {
{ "oauth2_client_credentials", new string[0] }
}
},
consumes = documentContext.IsCompositeContext
? null
: OpenApiMetadataDocumentHelper.GetConsumes(),
produces = OpenApiMetadataDocumentHelper.GetProduces(),
tags = tagsFactory.Create(resources),
paths = pathsFactory.Create(resources, documentContext.IsCompositeContext),
definitions = definitionsFactory.Create(resources),
parameters = parametersFactory.Create(documentContext.IsCompositeContext),
responses = responsesFactory.Create()
};
return(JsonConvert.SerializeObject(
openApiMetadataDocument,
new JsonSerializerSettings {
NullValueHandling = NullValueHandling.Ignore
}));
}
catch (Exception ex)
{
_logger.Error(ex);
throw;
}
}
