apiDiscovery - API ディスカバリー (apiDiscovery)

REST API を文書化するための API ディスカバリー機能の構成。

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20更新を listen している並行 REST API クライアントの最大数を指定します。
apiNamestring集約された API の名前。
publicURLstring/apiパブリック API ドキュメンテーション・エンドポイントのコンテキスト・ルートを指定します。この URL にはスラッシュ (/) は不要です。
swaggerDefinitionstringJSON または YAML Swagger スニペットのファイルの場所または URL、あるいは集約された Swagger 定義として使用されるアプリケーションのコンテキスト・ルート。

webModuleDoc

公開する API 文書を提供する各 Web モジュールの構成。

NameTypeDefaultDescription
idstring固有の構成 ID。
contextRootstring文書を提供する対象となる Web モジュールのコンテキスト・ルート。
enabledbooleantrueこの Web モジュールの文書の処理を制御するブール値。
docURLstringこの Web モジュールの文書の URL。 この URL はスラッシュ (/) で始まるコンテキスト・ルートからの相対表記か、http または https で始まる絶対表記にすることができます。
publicbooleantrueパブリック API に Web モジュールが表示されるかどうかを制御するブール値。