Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

NullPointerException when trying to parse OAS3 from a String

オープン
#45 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
52/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
java
領域
api

調査の方向性

まず StringParseTest.testSelfContainedOasSpec を再現し、次に ReferenceManager.java の getDocReference と、スタックトレースに示されている OpenApiParser.java の parse オーバーロードを調べます。null の resolutionBase を指定して自己完結型の OAS3 文字列を解析でき、title と path のアサーションが NullPointerException なしで成功すれば、修正は完了です。

索引モデルが issue の本文から書いたものです。

説明

The KaiZen-OpenApi-Parser documentation sounds as if the "resolutionBase" can be left empty if the OAS3 is fully self-contained and no relative references are used:

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 ...
	}
主要言語
Java
スター
13
フォーク
9
PR マージ指標
30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

networknt/openapi-parser のほかの issue

networknt/openapi-parser の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。