API ディスカバリー (apiDiscovery)
REST API を文書化するための API ディスカバリー機能の構成。
属性名 | データ型 | デフォルト値 | 説明 |
---|---|---|---|
apiName | string | 集約された API の名前。 | |
maxSubscriptions | int
最小: 0 最大: 100 |
20 | 更新を listen している並行 REST API クライアントの最大数を指定します。 |
publicURL | string | /api | %publicURL.desc |
swaggerDefinition | string | %swaggerDefinition.desc |
- webModuleDoc
説明: 公開する API 文書を提供する各 Web モジュールの構成。必須: falseデータ型: 属性名 データ型 デフォルト値 説明 contextRoot string 文書を提供する対象となる Web モジュールのコンテキスト・ルート。 docURL string この Web モジュールの文書の URL。 この URL はスラッシュ (/) で始まるコンテキスト・ルートからの相対表記か、http または https で始まる絶対表記にすることができます。 enabled boolean true この Web モジュールの文書の処理を制御するブール値。 id string 固有の構成 ID。 public boolean true %public.desc