networknt / openapi-parser Goto Github PK

View Code? Open in Web Editor NEW

7.0 18.0 6.0 492 KB

A light-weight, fast OpenAPI 3.0 parser and validator with minimum third party dependencies

License: Eclipse Public License 1.0

Java 99.91% Objective-J 0.09%

openapi openapi3 openapi-specification openapi-spec openapi-validation

openapi-parser's Introduction

openapi-parser

A light-weight, fast OpenAPI 3.0 parser and validator with minimum third party dependencies.

It is based on the generated code from KaiZen OpenAPI Parser without dependency on javaparser-core, guava, commons-cli, commons-io, javax.mail and guice.

License

The OpenAPI Parser is provided under the Eclipse Public License 1.0 following the parent KaiZen OpenAPI Parser

openapi-parser's People

Contributors

Stargazers

Watchers

Forkers

jenkins-poc maybeec balloonwen delanym r-gruber atmoshaman

openapi-parser's Issues

upgrade jackson-databind to 2.9.9.3

remove the json-overlay version to use light-4j version

Since json-overlay is released along with light-4j so we are going to use light-4j version for all networknt dependencies.

remove the temporary version.jackson-databind in the pom.xml

It was introduced due to an unmatched release from Jackson core and it is not necessary now.

remove dependency of commons-lang3

update openapi and inject merge to return inject if openapi is null

This is for the light-gateway case to allow validation for the adm endpoints.

Add back the service dependency in the pom.xml

During the refactoring, I have removed the service dependency and it needs to be rolled back.

cannot handle multiple schemas

We send message of spec1 and message validates. When we send another message, a new OpenApiValidator object is created for spec2, but the message fails to validate.

OpenApiHelper is implemented as a singleton

openapi-parser/src/main/java/com/networknt/openapi/OpenApiHelper.java

Line 74 in 4a3b082

public synchronized static OpenApiHelper init(String spec) {

but this method doesn't check that a different schema is being used, so it fails subsequent validations.

Fix the parseTest.yaml in the right position to remove the duplicates

move the openapi-helper from light-rest-4j to this repo for easy sharing

fix javadoc issue for the merge

Dependency on old unmaintained version of javamail 1.6.2 should be updated to use jakarta.mail

The current pom depends on the older unmaintained javax.mail namespace

(Even though the README says this project does not depend on javax.mail)

<dependency>
    <groupId>com.sun.mail</groupId>
    <artifactId>javax.mail</artifactId>
    <version>${version.javamail}</version>
</dependency>
        
<version.javamail>1.6.2</version.javamail>

I think we should either remove this dependency (to stay true to the README) or update to use the currently maintained jakarta.mail namespace

<dependency>
  <artifactId>jakarta.mail</artifactId>
  <groupId>com.sun.mail</groupId>
</dependency>

update github OAI/OpenAPI-specification repo from master to main

The target repo has switched the default branch to the main from the master.

upgrade jackson to 2.9.5 and make dependencies explict

Lower version of Jackson has CVE-2017-17485 deserialization flaw that is found by one of our customers during security scanning.

Add Petstore OpenAPI 3.0 spec and test case

add a new method to reset the specification for the light-portal

to handle the specification upload event. For each event, we need to reset the specification to parse the endpoints.

update pom.xml to remove the dependency for light-4j service module

WARNING]
[WARNING] Some problems were encountered while building the effective model for com.networknt:openapi-parser:jar:1.5.5
[WARNING] 'build.plugins.plugin.version' for org.apache.maven.plugins:maven-deploy-plugin is missing.
[WARNING]
[WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
[WARNING]
[WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
[WARNING]

https://github.com/RepreZen/KaiZen-OpenApi-Parser/blob/master/API-Overview.md
OpenApi3 parse(String model, URL resolutionBase) - parse a JSON or YAML string, with the given URL used for resolving any relative references encountered in the model. If resolutionBase is null, relative references will all fail resolution.

But calling the parse method without a resolutionBase leads to a NullPointerException:

java.lang.NullPointerException: Cannot invoke "java.net.URL.toString()" because "this.docUrl" is null
	at com.networknt.jsonoverlay.ReferenceManager.getDocReference(ReferenceManager.java:62)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:95)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:85)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:35)
	at com.networknt.oas.OpenApi3Parser.parse(OpenApi3Parser.java:29)
	at com.networknt.oas.OpenApi3Parser.parse(OpenApi3Parser.java:1)
	at com.networknt.oas.OpenApiParser.parse(OpenApiParser.java:28)
	at com.networknt.oas.OpenApi3Parser.parse(OpenApi3Parser.java:24)
	at com.networknt.oas.StringParseTest.testSelfContainedOasSpec(StringParseTest.java:57)

Here is a short test that I wrote:

public class StringParseTest {

	private final static String testTitle = "Test Title";
	private final static String testPath = "/test";

	private final String oas3String = //
		"openapi: 3.0.0\n" //
		+ "info:\n" //
		+ "  title: " + testTitle + "\n" //
		+ "  description: This is a description\n" //
		+ "  version: 1.0.0\n" //
		+ "servers:\n" //
		+ "  - url: https://localhost:8080\n" //
		+ "paths:\n" //
		+ "  " + testPath + ":\n" //
		+ "    get:\n" //
		+ "      description: Some endpoint\n" //
		+ "      operationId: testOps\n" //
		+ "      responses:\n" //
		+ "        '200':\n" //
		+ "          description: Successful operation\n";

	@Test
	public void testSelfContainedOasSpec() throws Exception {
		// no need to pass a resolutionBase since the spec is self contained
		OpenApi3 oas3 = new OpenApi3Parser().parse(this.oas3String, null);

		assertEquals(testTitle, oas3.getInfo().getTitle());

		Map<String, Path> paths = oas3.getPaths();
		assertEquals(1, paths.size());
		assertEquals("/test", paths.entrySet().iterator().next().getKey());
	}
}

Please also note that this is only one issue. It looks like there are more issues if I try to load more complicated OAS3 specs, like for instance here:

	@Test
	public void testYamlFileAsString() throws Exception {

		ClassLoader classLoader = ClassLoader.getSystemClassLoader();
		String oas3String;
		try (InputStream is = classLoader.getResourceAsStream("models/circular.yaml")) {
			assertNotNull(is);
			try (InputStreamReader isr = new InputStreamReader(is); BufferedReader reader = new BufferedReader(isr)) {
				oas3String = reader.lines().collect(Collectors.joining(System.lineSeparator()));
			}
		}		
		assertNotNull(oas3String);

		OpenApi3 oas3 = new OpenApi3Parser().parse(oas3String, null);
		// check oas3 object ...
	}