GET /api/mgmnt/v1/:namespace/spec/:application/
指定された REST サービスの OpenAPI 2.0 仕様Opens in a new tabを返します。このサービスは、手動コーディングの REST サービスである必要があります。
URL パラメータ
namespace | 必須。ネームスペース名。このパラメータでは大文字と小文字は区別されません。 |
application | 必須。REST サービス・クラスが格納されているパッケージの完全修飾名。 |
許可
このエンドポイントを使用するには、指定されたネームスペースに対する読み取りアクセス権を持っている必要があります。ネームスペースを指定しない場合、または指定したネームスペースが %SYS である場合は、既定のネームスペース (USER) に対する読み取りアクセス権を持っている必要があります。既定のネームスペースを別のネームスペースに設定できます。そのためには、グローバル・ノード ^%SYS("REST","UserNamespace") を目的のネームスペースに設定します。
また、ディスパッチ・クラスが格納されているデータベースに対する読み取りアクセス権も必要です。 ディスパッチ・クラスのネームスペースとエンドポイントのネームスペースは同じである必要があります (パッケージ内の % で始まるディスパッチ・クラスの場合を除きます。これはすべてのネームスペースに使用できます)。
要求の例
-
要求のメソッド :
GET
-
要求の URL :
http://localhost:52773/api/mgmnt/v1/user/spec/myapp
応答
この呼び出しは、https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.mdOpens in a new tab に記載されているような Swagger (OpenAPI 2.0Opens in a new tab) 仕様を返します。