// Public methods
public void Initialize()
{
_logger.LogInformation("Fetching Swagger Documentation for all services...");
// Iterate over all service names (in parallel)
Parallel.ForEach(WebServiceNames, async(webServiceName) =>
{
_logger.LogInformation($"Loading documentation for web-service: '{webServiceName}' ");
try
{
// Make async request to get the Swagger documentation JSON for a web-service
string documentationJson = await _clientRequestService.FetchServiceSwaggerJsonAsync(webServiceName);
// Add received documentation to thread-safe key-value store
_documentationStoreService[webServiceName] = documentationJson;
}
catch (HttpRequestException error)
{
_logger.LogInformation($"Client request error occurred while fetching documentation for web-service: '{webServiceName}'. {error}");
}
});
_logger.LogInformation("Successfully loaded documentation for all web-services.");
}
public async Task <IActionResult> GetSwaggerItem(string webServiceName)
{
// Check if webhook was called with valid web-service name
if (!_initializationService.IsValidWebServiceName(webServiceName))
{
// Return 400 response status
return(BadRequest($"Web-Service name is not valid. Passed name: '{webServiceName}'."));
}
// Get currently stored serialized JSON document for web-service (keyed on service name)
string previousJSON = _documentationStoreService[webServiceName];
// If no previous JSON document found, re-attempt to fetch the web service documentation
if (string.Equals(string.Empty, previousJSON))
{
// Reattempt to load Swagger documentation for this web-service (previous request must have failed)
bool isSuccessful = await _initializationService.ReattemptDocumentFetch(webServiceName);
if (isSuccessful)
{
// No previous documentation to compare with, return 200
_logger.LogInformation($"Successful loaded API documentation for web-service '{webServiceName}', but there is no previous document to compare it with.");
return(Ok());
}
else
{
// Return 400 response status with
return(BadRequest($"An error occurred while fetching new API documentation for web-service: '{webServiceName}'."));
}
}
// Attempt to get fresh JSON via client API request
string freshJSON = await _clientRequestService.FetchServiceSwaggerJsonAsync(webServiceName);
// Verify that we were able to fetch fresh API documentation for web-service
if (string.Equals(string.Empty, freshJSON))
{
// Return 400 response status with
return(BadRequest($"An error occurred while fetching new API documentation for web-service: '{webServiceName}'."));
}
// If documents are identical, short-circuit and do not perform diff checks
if (string.Equals(previousJSON, freshJSON))
{
_logger.LogInformation("Previous and Fresh JSON files are identical, skipping additional checks.");
return(Ok());
}
// We now know that the documentation has been updated, perform full suite of diff checks
await _compareService.CheckServiceForApiChanges(webServiceName, previousJSON, freshJSON);
// Update document store with newest version of documentation for this web-service
_documentationStoreService[webServiceName] = freshJSON;
// Return success status code
return(Ok());
}