問題タブ [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 に答える
934 参照

apiblueprint - リソース モデルを配列として再利用する

私は API を文書化していますが、非常によく似た 2 つの応答があります。

それらの 1 つは呼び出し /resource/{id} です。この応答は、リソース モデルを返します。

もう 1 つの呼び出しは、リソースのリストを返す /resource/search{?name,category} であるため、リソース モデルの配列を返す必要があります。

これができるかどうかわかりません。ブループリントのドキュメントには、Gists について同様の記述があります。ただし、Gist と Gist Collection の 2 つのモデルがあります。

私は自分自身を説明したことを願っています。

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

apiblueprint - Apiary.io は応答を抑制しますか?

apiary.io で RESTful サービスを呼び出す angularjs アプリがあります。

特定の数が受信された後、apiary.io は応答を抑制し、応答を遅らせますか?

もしそうなら、パラメータは何ですか?

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

apiblueprint - Rails の配列表記を使用したクエリ文字列パラメーターの API ブループリント ドキュメント

Rails の配列パラメーター表記を使用する API URI についてリソースの豊富なドキュメントを使用しようとしても、うまくいきません。

例 (わかりやすくするためにエンコードされていない URL):

/api/v2/profiles?ids[]=35&ids[]=47&ids[]=12&ids[]=132

実際にエンコードされた URL:

/api/v2/profiles?ids%5b%5d=35&ids%5b%5d=47&ids%5b%5d=12&ids%5b%5d=132

これは動作しません:

ベータ 3 列レイアウトに対してこれをテストします。古いレイアウトでは試していません。

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

apiblueprint - 設計図で投稿本文に入るパラメータを指定することはできますか?

パラメーターを URL パラメーターであるかのように文書化できるようにしたいと考えています。これは、その文書の一部が便利な表をどのようにレンダリングするかが気に入っているからです。ただし、私の API では、これらのパラメーターを URL ではなく JSON 本体にプラグインしたいと考えています。これを達成する方法はありますか?

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

sails.js - APIブループリント形式でセッションを表現する方法は?

現在、既存の API を で表現しようとしていますapiary.io。システムは、セッション ID を含む http-cookie を返すログイン要求を介して認証を実装します。

私の知る限り、別のリクエストを行うときに、ブラウザがホストから以前に受信したすべての http-cookie をブラウザに送信するのが標準です。

私の設計図ファイルによって生成されたテストを実行するとき、これは Dredd によって行われていないようです。このため、ユーザーのログインが必要なリクエストは、テストでは正しく機能しません。

Dredd にこれらの http-cookie の管理を強制するために、リクエストを「このリクエストを実行する前に必要」としてそれぞれマークする可能性はありますか?

ところで、REST サービスはSails.jsの mvc フレームワークである に実装されていnode.jsます。