Skip to content

Bugfix: application/problem+json など JSON 互換コンテンツタイプのスキーマバリデーション対応 #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wadakatu merged 2 commits into from
Feb 21, 2026
Merged

Bugfix: application/problem+json など JSON 互換コンテンツタイプのスキーマバリデーション対応 #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f03277f
fix(validator): support JSON-compatible content types beyond applicat…
wadakatu Feb 21, 2026
eccd75d
refactor(validator): address review feedback for JSON content type ma…
wadakatu Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 44 additions & 4 deletions src/OpenApiResponseValidator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@
use Opis\JsonSchema\Validator;

use function array_keys;
use function implode;
use function json_decode;
use function json_encode;
use function str_ends_with;
use function strtolower;

final class OpenApiResponseValidator
Expand Down Expand Up @@ -58,19 +60,35 @@ public function validate(

$responseSpec = $responses[$statusCodeStr];

// If no JSON content schema is defined for this response, skip body validation
if (!isset($responseSpec['content']['application/json']['schema'])) {
// If no content is defined for this response, skip body validation (e.g. 204 No Content)
if (!isset($responseSpec['content'])) {
return OpenApiValidationResult::success($matchedPath);
}

/** @var array<string, array<string, mixed>> $content */
$content = $responseSpec['content'];
$jsonContentType = $this->findJsonContentType($content);

if ($jsonContentType === null) {
$definedTypes = array_keys($content);

return OpenApiValidationResult::failure([
"No JSON-compatible content type found for {$method} {$matchedPath} (status {$statusCode}) in '{$specName}' spec. Defined content types: " . implode(', ', $definedTypes),
]);
}

if (!isset($content[$jsonContentType]['schema'])) {
return OpenApiValidationResult::success($matchedPath);
}

if ($responseBody === null) {
return OpenApiValidationResult::failure([
"Response body is empty but {$method} {$matchedPath} (status {$statusCode}) defines a JSON schema in '{$specName}' spec.",
"Response body is empty but {$method} {$matchedPath} (status {$statusCode}) defines a JSON-compatible response schema in '{$specName}' spec.",
]);
}

/** @var array<string, mixed> $schema */
$schema = $responseSpec['content']['application/json']['schema'];
$schema = $content[$jsonContentType]['schema'];
$jsonSchema = OpenApiSchemaConverter::convert($schema, $version);

// opis/json-schema requires an object, so encode then decode
Expand Down Expand Up @@ -107,4 +125,26 @@ public function validate(

return OpenApiValidationResult::failure($errors);
}

/**
* Find the first JSON-compatible content type from the response spec.
*
* Matches "application/json" exactly and any type with a "+json" structured
* syntax suffix (RFC 6838), such as "application/problem+json" and
* "application/vnd.api+json". Matching is case-insensitive.
*
* @param array<string, array<string, mixed>> $content
*/
private function findJsonContentType(array $content): ?string
{
foreach ($content as $contentType => $mediaType) {
$lower = strtolower($contentType);

if ($lower === 'application/json' || str_ends_with($lower, '+json')) {
return $contentType;
}
}

return null;
}
}
144 changes: 144 additions & 0 deletions tests/Unit/OpenApiResponseValidatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,114 @@ public function undefined_status_code_returns_failure(): void
$this->assertStringContainsString('Status code 404 not defined', $result->errors()[0]);
}

// ========================================
// OAS 3.0 JSON-compatible content type tests
// ========================================

#[Test]
public function v30_problem_json_valid_response_passes(): void
{
$result = $this->validator->validate(
'petstore-3.0',
'GET',
'/v1/pets',
400,
[
'type' => 'https://example.com/bad-request',
'title' => 'Bad Request',
'status' => 400,
'detail' => 'Invalid query parameter',
],
);

$this->assertTrue($result->isValid());
$this->assertSame('/v1/pets', $result->matchedPath());
}

#[Test]
public function v30_problem_json_invalid_response_fails(): void
{
$result = $this->validator->validate(
'petstore-3.0',
'GET',
'/v1/pets',
400,
[
'type' => 'https://example.com/bad-request',
'title' => 'Bad Request',
'status' => 'not-an-integer',
],
);

$this->assertFalse($result->isValid());
$this->assertNotEmpty($result->errors());
}

#[Test]
public function v30_problem_json_empty_body_fails(): void
{
$result = $this->validator->validate(
'petstore-3.0',
'GET',
'/v1/pets',
400,
null,
);

$this->assertFalse($result->isValid());
$this->assertStringContainsString('Response body is empty', $result->errors()[0]);
}

#[Test]
public function v30_content_without_json_compatible_type_fails(): void
{
$result = $this->validator->validate(
'petstore-3.0',
'POST',
'/v1/pets',
415,
'<error>Unsupported</error>',
);

$this->assertFalse($result->isValid());
$this->assertStringContainsString('No JSON-compatible content type found', $result->errors()[0]);
$this->assertStringContainsString('application/xml', $result->errors()[0]);
}

#[Test]
public function v30_case_insensitive_content_type_matches(): void
{
$result = $this->validator->validate(
'petstore-3.0',
'GET',
'/v1/pets',
422,
[
'type' => 'https://example.com/validation-error',
'title' => 'Validation Error',
'status' => 422,
],
);

$this->assertTrue($result->isValid());
$this->assertSame('/v1/pets', $result->matchedPath());
}

#[Test]
public function v30_json_content_type_without_schema_skips_validation(): void
{
$result = $this->validator->validate(
'petstore-3.0',
'GET',
'/v1/pets',
500,
['error' => 'something went wrong'],
);

$this->assertTrue($result->isValid());
$this->assertSame('/v1/pets', $result->matchedPath());
}

// ========================================
// OAS 3.1 tests
// ========================================
Expand Down Expand Up @@ -195,6 +303,42 @@ public function v31_invalid_response_fails(): void
$this->assertNotEmpty($result->errors());
}

#[Test]
public function v31_problem_json_valid_response_passes(): void
{
$result = $this->validator->validate(
'petstore-3.1',
'GET',
'/v1/pets',
400,
[
'type' => 'https://example.com/bad-request',
'title' => 'Bad Request',
'status' => 400,
'detail' => null,
],
);

$this->assertTrue($result->isValid());
$this->assertSame('/v1/pets', $result->matchedPath());
}

#[Test]
public function v31_content_without_json_compatible_type_fails(): void
{
$result = $this->validator->validate(
'petstore-3.1',
'POST',
'/v1/pets',
415,
'<error>Unsupported</error>',
);

$this->assertFalse($result->isValid());
$this->assertStringContainsString('No JSON-compatible content type found', $result->errors()[0]);
$this->assertStringContainsString('application/xml', $result->errors()[0]);
}

#[Test]
public function v31_no_content_response_passes(): void
{
Expand Down
88 changes: 88 additions & 0 deletions tests/fixtures/specs/petstore-3.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,59 @@
}
}
}
},
"422": {
"description": "Validation error",
"content": {
"Application/Problem+JSON": {
"schema": {
"type": "object",
"required": ["type", "title", "status"],
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer"
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {}
}
},
"400": {
"description": "Bad request",
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"required": ["type", "title", "status"],
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer"
},
"detail": {
"type": "string"
}
}
}
}
}
}
}
},
Expand Down Expand Up @@ -76,6 +129,16 @@
}
}
}
},
"415": {
"description": "Unsupported media type",
"content": {
"application/xml": {
"schema": {
"type": "string"
}
}
}
}
}
}
Expand Down Expand Up @@ -137,6 +200,31 @@
}
}
}
},
"404": {
"description": "Pet not found",
"content": {
"application/problem+json": {
"schema": {
"type": "object",
"required": ["type", "title", "status"],
"properties": {
"type": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "integer"
},
"detail": {
"type": "string"
}
}
}
}
}
}
}
},
Expand Down
Loading