REST API を文書化するための API ディスカバリー機能の構成。
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | 更新を listen している並行 REST API クライアントの最大数を指定します。 |
apiName | string | 集約された API の名前。 | |
publicURL | string | /api | パブリック API ドキュメンテーション・エンドポイントのコンテキスト・ルートを指定します。この URL にはスラッシュ (/) は不要です。 |
swaggerDefinition | string | JSON または YAML Swagger スニペットのファイルの場所または URL、あるいは集約された Swagger 定義として使用されるアプリケーションのコンテキスト・ルート。 |
公開する API 文書を提供する各 Web モジュールの構成。
Name | Type | Default | Description |
---|---|---|---|
id | string | 固有の構成 ID。 | |
contextRoot | string | 文書を提供する対象となる Web モジュールのコンテキスト・ルート。 | |
enabled | boolean | true | この Web モジュールの文書の処理を制御するブール値。 |
docURL | string | この Web モジュールの文書の URL。 この URL はスラッシュ (/) で始まるコンテキスト・ルートからの相対表記か、http または https で始まる絶対表記にすることができます。 | |
public | boolean | true | パブリック API に Web モジュールが表示されるかどうかを制御するブール値。 |