REST エンドポイントジェネレータのプロンプト

次のセクションに記載されているプロンプトで一般的な場合は、一般的な子リソースでエンドポイントを生成する場合です。すべての応答で大文字と小文字が区別されます。

Which data model entity would you like to generate endpoints for?
Java

カスタムエンティティ名を指定します。

指定したエンティティの名前で先頭と末尾のどちらにも Ext が付いていない場合、追加のプロンプトで、Ext をリソース名に追加することが確認されます。「y」と入力することで受け入れる必要があります。「y」を入力しないと、ジェネレータは不正状態の例外をスローし、実行を停止します。

The default plural for this entity is <defaultValue>. If you want to use a different plural, 
specify it and press Enter. To accept the default, just press Enter.
Java

コレクションリソースのカスタム名を指定するか、Enter キーを押してデフォルト名を受け入れます。

The url string for <entityName> will use the following hyphenation: <defaultValue>.
If you would like to use a different hyphenation, please enter it here (leave blank to use 
the default, all capitalized letters will be converted to lowercase):
Java

カスタムエンティティの名前に複数の大文字や連続した数字がある場合、エンドポイントパスにデフォルトのハイフン挿入を行ったものを REST エンドポイントジェネレータは表示します(BOPLine_Ext という名前のカスタムエンティティに対する /bop-line-ext など)。カスタムハイフン挿入アプローチ(/bopline-ext など)を指定できますし、Enter キーを押してデフォルトを受け入れることができます。

Which API should the endpoints be added to?
Java

API 名を指定します。技術的な名前は小文字で指定します(Common API に対する common や Admin API に対する admin など)。

エンドポイントは、Composite API、System Tools API、または Test Util API に追加できません。

Is the CustomaEntity_Ext endpoint the (r)oot of the endpoint path (e.g. GET /activities) 
or the (c)hild of another resource (e.g. GET /activities/{activityId}/notes)? r/c
Java

「c」を入力して、カスタムリソースを、既存の親リソースの子にします。

「c」を入力して、カスタムリソースを、既存の親リソースの子にします(このプロンプトは有効日エンティティには提示されません。有効日エンティティはルートリソースにできません)。

What is the resource name of the parent?
Java
親のリソース名を入力します。
  • これは、親リソースのスキーマからの resourceType の値です。
  • これはコレクション(Activities など)ではなく要素リソース(Activity など)である必要があります。
  • 子エンドポイントを生成するには、親リソースに対して CRUD エンドポイントのセットが存在している必要があります。

大部分のエンドポイントについて、リソース名は、エンドポイントパスに含まれるものと同じであることに注意してください。例えば、GET /activities/{ActivityId} のリソース名は Activity です。ただし、エンドポイントパスがリソース名と異なる場合もあります。例えば、GET /contacts/{contactId} のリソース名は Contact ではなく ClaimContact です。正しい名前を使用していることを確認するには、親リソースのスキーマからの resourceType を調べます。

Is the collection resource backed by a (s)tream or (q)uery?
Java

コレクションの読み込みに Java ストリームと Gosu クエリのいずれを使用するのかを選択します。

Which roles can access the GET collection and GET element endpoint? 
Here are the options [<list-of-roles>]
Enter the values separated by comma. If you do not want to specify roles, just press Enter.
Java

REST エンドポイントジェネレータは、使用可能な役割をリストします。GET アクセス権を付与される役割のカンマ区切りリストを入力します。

いずれの権限プロンプトにも回答する必要がないことに注意してください。各プロンプトに、Enter キーを押すことができます。ただし、これは REST エンドポイントジェネレータによって行われるコード化を回避するだけです。これにより、エンドポイントに対して権限をコンフィギュレーションする必要がなくなるわけではありません。

Which roles can access the POST collection endpoint? 
Here are the options [<list-of-roles>]
Enter the values separated by comma. If you do not want to specify roles, just press Enter.
Java

REST エンドポイントジェネレータは、使用可能な役割をリストします。POST アクセス権を付与される役割のカンマ区切りリストを入力します。POST アクセス権では、GET アクセス権が必要なことに注意してください。したがって、GET アクセス権を付与されなかった役割には、POST アクセス権は付与されません。

Which roles can access the PATCH element endpoint?
Here are the options [<list-of-roles>]
Enter the values separated by comma. If you do not want to specify roles, just press Enter.
Java

REST エンドポイントジェネレータは、使用可能な役割をリストします。PATCH アクセス権を付与される役割のカンマ区切りリストを入力します。PATCH アクセス権では、GET アクセス権が必要なことに注意してください。したがって、GET アクセス権を付与されなかった役割には、PATCH アクセス権は付与されません。

Which roles can access the DELETE element endpoint?
Here are the options [<list-of-roles>]
Enter the values separated by comma. If you do not want to specify roles, just press Enter.
Java

REST エンドポイントジェネレータは、使用可能な役割をリストします。DELETE アクセス権を付与される役割のカンマ区切りリストを入力します。DELETE アクセス権では、GET アクセス権が必要なことに注意してください。したがって、GET アクセス権を付与されなかった役割には、DELETE アクセス権は付与されません。

Should <CustomEntity> be added to an integration graph?
Java

「y」または「n」を入力します。連携グラフへのカスタムリソースの追加の詳細については、生成されたエンドポイントに関するその他の考慮事項を参照してください。

スクリプトの完了

REST エンドポイントジェネレータのスクリプトが正常に完了すると、以下の例に示すような、作成または変更されたファイルに関する情報が出力されます。

2022-03-18 16:42:42,817 INFO Beginning endpoint generation2022-03-18 16:42:42,818 INFO Generating resource classes
2022-03-18 16:42:42,832 INFO Modifying configuration file <api_collection>_ext-1.0.swagger.yaml
2022-03-18 16:42:42,877 INFO Modifying configuration file <api_collection>_ext-1.0.mapping.json
2022-03-18 16:42:42,880 INFO Modifying configuration file <api_collection>_ext-1.0.updater.json
2022-03-18 16:42:42,885 INFO Modifying configuration file shared_ext-1.0.apiconfig.yaml
2022-03-18 16:42:42,903 INFO Modifying configuration file default_ext-1.0.access.yaml
2022-03-18 16:42:42,905 INFO Modifying configuration file gwabuid_ext-1.0.access.yaml
2022-03-18 16:42:42,907 INFO Modifying configuration file internal_ext-1.0.access.yaml
2022-03-18 16:42:42,909 INFO Modifying configuration file policyNumbers_ext-1.0.access.yaml
2022-03-18 16:42:42,917 INFO Modifying configuration file <role>.role.yaml
2022-03-18 16:42:42,939 INFO Finished endpoint generation
Java