← ツールホーム100% クライアントサイド処理

GraphQL SDL to JSON Schema & OpenAPI コンバーター

GraphQL SDL のスキーマ定義、型、クエリ、ミューテーションを、標準的な JSON Schema Draft-07 および OpenAPI コンポーネントスキーマへ直接変換します。

出力仕様:

フィールドの説明文（Docstring）を含める厳密な非Null（Non-Null）フィールドを強制

GraphQL SDL 入力47 lines

生成されたスキーマ出力

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "GraphQLConvertedSchema",
  "type": "object",
  "definitions": {
    "User": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "username": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "bio": {
          "type": [
            "string",
            "null"
          ]
        },
        "isActive": {
          "type": "boolean"
        },
        "role": {
          "$ref": "#/definitions/UserRole"
        },
        "posts": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Post"
          }
        },
        "createdAt": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "username",
        "email",
        "isActive",
        "role",
        "posts",
        "createdAt"
      ],
      "description": "User account definition with profile details"
    },
    "UserRole": {
      "type": "string",
      "enum": [
        "ADMIN",
        "EDITOR",
        "SUBSCRIBER",
        "GUEST"
      ],
      "description": "System role access level"
    },
    "Post": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "content": {
          "type": "string"
        },
        "published": {
          "type": "boolean"
        },
        "author": {
          "$ref": "#/definitions/User"
        },
        "tags": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "viewCount": {
          "type": "integer"
        },
        "rating": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "title",
        "content",
        "published",
        "author",
        "viewCount"
      ],
      "description": "Blog publication entity"
    },
    "CreatePostInput": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "content": {
          "type": "string"
        },
        "tags": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "published": {
          "type": [
            "boolean",
            "null"
          ]
        }
      },
      "required": [
        "title",
        "content"
      ]
    },
    "SearchResult": {
      "anyOf": [
        {
          "$ref": "#/definitions/User"
        },
        {
          "$ref": "#/definitions/Post"
        }
      ]
    }
  }
}

パースされた型数

5definitions

変換されたフィールド数

20attributes

スキーマサイズ

JSON Schema Draft-07

技術リファレンス＆アーキテクチャガイド

GraphQL SDL to JSON Schema & OpenAPI コンバーター — リファレンスガイド

GraphQL SDL のスキーマ定義、型、クエリ、ミューテーションを、標準的な JSON Schema Draft-07 および OpenAPI コンポーネントスキーマへ直接変換します。

主要パラメータ＆設定項目

schemaSdlstring

型、インプット型、列挙型（enum）、ユニオン型、クエリ、ミューテーションを定義する生の GraphQL スキーマ定義言語（SDL）ソーステキスト。

targetFormatstring

'json-schema-draft-07'、'json-schema-2020-12'、'openapi-3.0'、'openapi-3.1' などの出力先スキーマ仕様フォーマット。

includeDirectivesboolean

カスタム GraphQL SDL ディレクティブ（例: @deprecated, @description, バリデーションルールなど）を標準スキーマキーワードや 'x-graphql-directives' などの拡張フィールドに変換するかどうか。

nullableFieldsStrategystring

GraphQL の nullable フィールドと Non-Null（'!'）型の処理戦略。JSON Schema の 'type': ['string', 'null'] または OpenAPI の 'nullable: true' へのマッピング方針。

プロの活用テクニック＆推奨設定

よくあるトラブルと解決策

SDL パース時の SyntaxError: Unexpected character / Unknown type

変換前に標準の GraphQL 文法仕様に準拠しているかを検証してください。すべてのカスタムスカラー（例: DateTime, JSON, UUID）が SDL 内で 'scalar ScalarName' として明示的に宣言されていることを確認してください。

スキーマ生成時の循環参照エラーまたは無限コールスタッククラッシュ

インラインでのスキーマ再帰展開を無効化し、ルートの '#/components/schemas' または '#/definitions' 識別子を用いた参照ベースの生成を有効にして、循環構造が JSON ポインタ経由で解決されるようにします。

'type: ["string", "null"]' 構文に起因する OpenAPI 3.0 バリデーションエラー

ターゲットフォーマットを明示的に OpenAPI 3.0 に設定し、'type: string' と 'nullable: true' のペアを使用してください。複数型の配列指定は OpenAPI 3.1 および JSON Schema Draft-2020-12 より前のバージョンではサポートされていません。

よくある質問 (FAQ)

▼