問題タブ [raml]

現在、API を生成しようとしていますが、リスト グループ内の最初のメソッドの説明を追加するのに苦労しています。最初のメソッドだけでなく、グループ内の他のすべてのメソッドの説明を追加できます。

どのように表示するかを示す画像を下に添付しましたが、RAMLtoHTML ジェネレーターを使用してこれを実現することはできません。

以下は、メインファイルで使用しているコードです。このファイルには、私が問題を抱えているファイルのインクルードがあります。私はそれで何かを変えることができるかもしれないと思っていましたか？

これは、以下に説明を追加したいファイルです。ご覧のとおり、既にリストの説明を追加しています。ここにメソッドの説明を追加しようとすると、「説明」が既に定義されているという苦情がパーサーから返されます。

これに対する回避策はありますか？インクルードの前に最初のファイル内に説明を追加しようとしましたが、パーサー エラーが発生します。/hubs 宣言を 2 番目のファイル内に移動しようとしましたが、それを解析できる唯一の方法は、メソッド呼び出し URL に余分な文字を追加することです。これは理想とはほど遠いものです。

RAML を初めて使用するので、基本的な質問があります。

代替 baseUri のセットを指定することはできません (単一のみが許可されます)。API の複数の代替インストールをモデル化する代替方法はありますか (たとえば、個別のリリース サイクル環境用)?

RAML (およびおそらく Swagger も) を使用して文書化したい ReSTful サービスを準備していますが、JAX-RS と RAML の両方を同じアプリケーションに同時に実装することはできないようです。

次のように、JAX-RS の Application クラスを作成しました。

JAX-RS Application オブジェクトを次のようにアタッチします。

また、RAML 拡張も実装したいと思いますが、Restlet Router に関連付けられており、独自の Application クラスを持っているようです。2つを組み合わせる方法はありますか？

URL パラメータの任意のリストを持つ RAML で GET リクエストをモデル化しようとしています。2 つのパラメーターが既知ですが、残りは他の要求タイプからの応答データから選択された名前と値のペアです。queryParameters リストで additionalParameters: true を使用しようとしましたが、RAML を解析しようとすると、osprey-mock-service からエラー メッセージが表示されます。

私のRAMLからの関連するスニペットは次のとおりです。

次の行を削除すると、エラー メッセージが消えます。

additionalParameters を queryParameters と共に使用できることを示すリファレンスは見つかりませんでしたが、できることは理にかなっているようです。

必ずしもエラー メッセージを解決する必要はありませんが、次のような URL パラメーターが必要です。

content と node は事前定義されたパラメーター名ではありません。

これは可能ですか？

JSONスキーマでプロパティを定義している状況について混乱しています。

productスキーマを定義しようとしている項目があるとします。私のデータベースでは、productsテーブルにはid、brand_id、name、item_numberおよびがありdescriptionます。以外descriptionはすべて必須フィールドです。はidデータベースによってbrand_id自動生成され、ユーザーの作成に基づいて API によって自動的に作成時に設定されます。

これはPOST /api/products、次のデータのみを使用できることを意味します。

しかし、製品スキーマをどのように定義すればよいでしょうか? プロパティidとを含める必要がありbrand_idますか? もしそうなら、それらは自動的に設定されますが、必須としてラベル付けする必要がありますか?

これは私が思いついたものです：

RAMLを使用して REST API を文書化しています。RAML ドキュメントでは、ルート レベルでベース URL を指定します。

次に、ドキュメントの API エンドポイント セクションで、このベースに関連する URL を指定します。

raml2htmlRAML ドキュメントから HTML ページを生成するために実行すると、相対 URL が API エンドポイントのドキュメントに表示されますが、代わりに/foo/bar絶対 URL を表示したいのですが、これは可能ですか?http://api.example.org/api/v1/foo/bar

mule + raml + counchDB で Web アプリケーションを実装しています。それは非常にうまくいっています。しかし、今は認証機能を開発する必要があります。API クライアントだけでなく、このクライアントのユーザーも検証します。目標は、通常の Web アプリケーションと同じ動作に到達することです。ユーザーが URL を呼び出すと、ログイン ページが読み込まれ、ユーザーがユーザー名とパスワードを入力して認証されます。その後、リクエストごとに、ユーザーのログインと url パラメーターを検証して、情報にアクセスする権利があることを確認する必要があります。

しかし、それを行う最善の方法は何か、またはラバで可能である場合でも、私は迷っています。HTTP 基本認証について読んだことがありますが、必要なものに適合することがわかっています。しかし、muof ユーザーを認証し、それを管理して正しい検証を実行できるかどうかはわかりませんでした。

ご清聴ありがとうございました、ヴァルター・ゴメス

Restlet 2.3.1 (JSE) を使用するプロジェクトがあります。Restlet Web サイトに従って maven を使用しています。

これはすべて正常に動作しますが、RAML 拡張機能を追加しようとすると:

次のエラーが表示されます。