使用される OpenAPI のプロパティ Contents Swagger Info オブジェクト Path Item オブジェクト Operation オブジェクト Parameter オブジェクト Items オブジェクト この付録には、REST サービス・クラスを生成するときに API 管理ツールで使用される OpenAPI 2.0 仕様Opens in a new tabのプロパティを掲載しています。ここに掲載されていないプロパティは無視されます。拡張プロパティがいくつかあります。拡張プロパティの名前は x-ISC で始まります。 Swagger basePath consumes host produces definitions (API 管理ツールでは、コードを生成する際に Schema オブジェクトのいずれのプロパティも使用されません) parameters (詳細は、“Parameter オブジェクト” を参照してください) paths (詳細は、“Path Item オブジェクト” を参照してください) info (詳細は、“Info オブジェクト” を参照してください) swagger ("2.0" でなければなりません) これらのプロパティの詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swagger-objectOpens in a new tab を参照してください。 Info オブジェクト title description x-ISC_RequiredResource (REST サービスのすべてのエンドポイントへのアクセスに必要となる、定義したリソースとそのアクセス・モード (resource:mode) のコンマ区切りリスト) version 標準プロパティの詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-objectOpens in a new tab を参照してください。 Path Item オブジェクト $ref get、put など (OpenAPI 2.0 仕様Opens in a new tabに掲載されているすべてのメソッドがサポートされています)options メソッドについては、実装するスタブ・メソッドは生成されません。代わりに、クラス %CSP.RESTOpens in a new tab によって、options のすべての処理が自動的に実行されます。 parameters (詳細は、“Parameter オブジェクト” を参照してください) これらのプロパティの詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemObjectOpens in a new tab を参照してください。 Operation オブジェクト operationId summary description consumes produces parameters (詳細は、“Parameter オブジェクト” を参照してください) x-ISC_CORS (このエンドポイント/メソッドの組み合わせの CORS 要求をサポートするかどうかを示すフラグ) x-ISC_RequiredResource (REST サービスのこのエンドポイントへのアクセスに必要となる、定義したリソースとそのアクセス・モード (resource:mode) のコンマ区切りリスト) x-ISC_ServiceMethod (この操作を処理するためにバックエンドで呼び出されるクラス・メソッドの名前。既定値は operationId で、通常はこのままで適切です) responses (応答オブジェクト内では、status は HTTP ステータス・コードまたは "default" です) 標準プロパティの詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operationObjectOpens in a new tab を参照してください。 Parameter オブジェクト name in description required $ref type ("formData" にすることはできません。他のタイプは使用できます) format allowEmptyValue maxLength minLength pattern maximum minimum exclusiveMaximum exclusiveMinimum multipleOf collectionFormat minItems maxItems uniqueItems items (詳細は、“Items オブジェクト” を参照してください) これらのプロパティの詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-objectOpens in a new tab を参照してください。 Items オブジェクト type format allowEmptyValue maxLength minLength pattern maximum minimum exclusiveMaximum exclusiveMinimum multipleOf collectionFormat minItems maxItems uniqueItems これらのプロパティの詳細は、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#items-objectOpens in a new tab を参照してください。
