問題タブ [apiblueprint]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
1 に答える
1206 参照

rest - Aglio では、ボディ内のパラメーターをパラメーターとして定義することはできません

API ブループリント レンダラーである Aglio では、リクエストの本文のパラメーターをエンドポイント仕様のパラメーター セクションに含めることはできません。次のように解析警告をスローします。

parameter '<some_parameter>' not specified in '<some_description>' its '<some_URI_template>' URI template (warning code 8)

この警告を再現する Markdown の例は次のとおりです。

URI テンプレートに含まれていないため、レンダリングされた 'destination' がパラメーターになることは好まれません。

私の質問は、これはツールの欠点ですか、それとも API ブループリントの仕様ですか? また、おそらく、この REST エンドポイントの定義は標準に準拠していないのでしょうか?

0 投票する
1 に答える
4173 参照

apiblueprint - API ブループリントでリクエスト ヘッダーを指定する方法

リクエスト ヘッダーを使用して返すコンテンツ タイプを理解するリソースの API ブループリントを定義しようとしています。

私は私の要求が次のようになることを望みます:-

API ブループリントを使用してそれを文書化するにはどうすればよいですか?

0 投票する
2 に答える
1249 参照

rest - apiary: 認識されないブロックを無視しています

サービスがアクセス権を投稿するために、apiary に次の定義があります。

Apiary は、Request ブロックと Response ブロックが認識されていないと教えてくれました。フィールドを必須にしたり、パラメータを必須にしたり、フィールドのスペルを変更したり、(application/json) を削除したり、間隔をいじったりしました。何も役に立たないようです。Request and Response ブロックの何が問題になっていますか?