Added support for OAS 3.0

Author: Chris Wiechmann

src/main/java/com/axway/apim/openapi/validator/APIManagerSchemaProvider.java

@@ -11,6 +11,7 @@ public class APIManagerSchemaProvider {
 
 	public APIManagerSchemaProvider(String apiManagerUrl, String username, String password) throws Exception {
 		super();
+		Utils.traceMessage("Creating API-Manager OpenAPI provider for URL: "+apiManagerUrl, TraceLevel.INFO);
 		this.apiManager = new APIManagerHttpClient(apiManagerUrl, username, password);
 	}
 
@@ -22,6 +23,16 @@ public String getSchema(String apiId) throws Exception {
 			int statusCode = httpResponse.getStatusLine().getStatusCode();
 			String response = EntityUtils.toString(httpResponse.getEntity());
 			if(statusCode!=200) {
+				if(statusCode==500 && response!=null && response.contains("Failed to download API")) {
+					// Try to download an OAS 3.0 spec instead
+					Utils.traceMessage("No SwaggerVersion 2.0 API-Specification found, trying to download OpenAPI 3.0 specification.", TraceLevel.DEBUG);
+					httpResponse = apiManager.get("/discovery/swagger/api/id/"+apiId+"?swaggerVersion=3.0");
+					statusCode = httpResponse.getStatusLine().getStatusCode();
+					response = EntityUtils.toString(httpResponse.getEntity());
+					if(statusCode==200) { 
+						return response;
+					}
+				}
 				Utils.traceMessage("Error getting API-Specification from API-Manager. Received Status-Code: " +statusCode+ ", Response: '" + response + "'", TraceLevel.ERROR);
 				throw new IllegalArgumentException("Error getting API-Specification from API-Manager");
 			}

src/main/java/com/axway/apim/openapi/validator/OpenAPIValidator.java

@@ -53,7 +53,7 @@ public static synchronized OpenAPIValidator getInstance(String apiId, String use
 		if(instances4APIIDs.containsKey(apiId)) {
 			return instances4APIIDs.get(apiId);
 		} else {
-			Utils.traceMessage("Creating new OpenAPI validator instance for given API-ID.", TraceLevel.INFO);
+			Utils.traceMessage("Creating new OpenAPI validator instance for given API-ID: '"+apiId+"'", TraceLevel.INFO);
 			OpenAPIValidator validator = new OpenAPIValidator(apiId, username, password, apiManagerUrl);
 			instances4APIIDs.put(apiId, validator);
 			return validator;
@@ -77,7 +77,7 @@ private OpenAPIValidator(String openAPISpec) {
     private OpenAPIValidator(String apiId, String username, String password, String apiManagerUrl) throws Exception {
 		super();
 		try {
-			Utils.traceMessage("Creating OpenAPIValidator from for: [apiId: '"+apiId+"', username: '"+username+"', password: '*******', apiManagerUrl: '"+apiManagerUrl+"']", TraceLevel.INFO);
+			Utils.traceMessage("Creating OpenAPIValidator for: [apiId: '"+apiId+"', username: '"+username+"', password: '*******', apiManagerUrl: '"+apiManagerUrl+"']", TraceLevel.INFO);
 			APIManagerSchemaProvider schemaProvider = new APIManagerSchemaProvider(apiManagerUrl, username, password);
 			String apiSpecification = schemaProvider.getSchema(apiId);
 			this.validator = OpenApiInteractionValidator.createForInlineApiSpecification(apiSpecification).build();
@@ -98,7 +98,7 @@ public boolean isValidRequest(String payload, String verb, String path, QueryStr
     }
 
     public boolean isValidResponse(String payload, String verb, String path, int status, HeaderSet headers) {
-    	Utils.traceMessage("Validate response: [verb: "+verb+", path: '"+path+"', status: +status+, payload: '"+Utils.getContentStart(payload, payloadLogMaxLength, true)+"']", TraceLevel.INFO);
+    	Utils.traceMessage("Validate response: [verb: "+verb+", path: '"+path+"', status: "+status+", payload: '"+Utils.getContentStart(payload, payloadLogMaxLength, true)+"']", TraceLevel.INFO);
     	ValidationReport validationReport = validateResponse(payload, verb, path, status, headers);
     	if (validationReport.hasErrors()) {
     		return false;

src/test/java/com/axway/apim/openapi/validator/TestAPIManagerBasedOpenAPIValidator.java

@@ -53,6 +53,31 @@ public void getAPISpecForInvalidApiId() throws Exception {
 		provider.getSchema("d45571e4-ec7d-444c-af09-99999999999");
 	}
 
+	@SuppressWarnings("resource")
+	@Test
+	public void getAPISpecForValidOAS30ApiId() throws Exception {
+		String failedToDownloadAPI = Files.readFile(this.getClass().getClassLoader().getResourceAsStream(TEST_PACKAGE + "FailedToDownloadAPI.json"));
+		// Initially trying to download Swagger 2.0
+		new MockServerClient("127.0.01", 1080)
+		.when(request()
+				.withPath("/api/portal/v1.3/discovery/swagger/api/id/d45571e4-ec7d-444c-af09-11265d75c446")
+				.withQueryStringParameter("swaggerVersion", "2.0")
+				)
+		.respond(response().withStatusCode(500).withBody(new JsonBody(failedToDownloadAPI))
+		);
+		new MockServerClient("127.0.01", 1080)
+		.when(request()
+				.withPath("/api/portal/v1.3/discovery/swagger/api/id/d45571e4-ec7d-444c-af09-11265d75c446")
+				.withQueryStringParameter("swaggerVersion", "3.0")
+				)
+		.respond(response().withStatusCode(200).withBody("{ This is supposed to be a swagger-file }")
+		);
+
+		APIManagerSchemaProvider provider = new APIManagerSchemaProvider("https://localhost:1080", "user", "password");
+		String apiSpec = provider.getSchema("d45571e4-ec7d-444c-af09-11265d75c446");
+		Assert.assertEquals(apiSpec, "{ This is supposed to be a swagger-file }");
+	}
+	
 	@SuppressWarnings("resource")
 	@Test
 	public void testOpenAPIBasedOnAPIManagerApiID() throws Exception {

src/test/resources/com/axway/apim/openapi/validator/FailedToDownloadAPI.json

@@ -0,0 +1 @@
+{"errors":[{"code":500,"message":"Failed to download API"}]}