問題タブ [apiblueprint]

apiary.io はリソース属性をポイント形式でリストします。これらの属性がどのようなデータ型であるか、またはフォーマットを指定するデータに適合するかを示す特定の規則はありますか?

dredd - API ブループリント テスト ツールをインストールし、実装に対して APIary API をテストしようとしました。

青写真では、somehost に正しく実装されているリソースが 1 つだけあります...しかし、テストは失敗します :(

テスト コマンド: dredd apiary.apib http://somehost.de:8443/imp-endpoint

出力： Info: Beginning Dredd testing... undefined

-l verboseやその他のオプションなど、未定義の詳細情報を取得するためのオプションも試しました。しかし、失敗に関する詳細情報は得られませんでした:(

誰もそれを経験したことがありますか？ありがとうございました！！！:)

応答に含まれるフィールドが異なる API の仕様を書いています。これを示すために、複数の例を提供できるようにしたいと思います。私のユースケースは次のとおりです。

1. API 呼び出しの 1 つにinclude、応答に含める追加フィールドをユーザーが指定できるようにするパラメーターがあります。
2. 一部の API 呼び出しでは、応答に含まれるフィールドは、ユーザーの API キーに関連付けられた権限によって異なります。

私ができるようにしたいのは、次のようなものです：

私が知る限り、複数の応答を提供することはできますが、応答コードまたはコンテンツ タイプが異なる場合にのみ可能です。これを行う方法はありますか？

設計図で書かれたドキュメントで API の実装を確認しようとしています。サーバーから返されたjsonがドキュメントで指定されたものと異なる場合、dreddは失敗すると予想していました。これを確認するために、dredd-exampleをコピーしました。最初に、元の apib ファイルで dredd を実行して、すべてが緑色であることを確認しました。次に、ドキュメントの応答を変更し、dreddが赤を表示することを期待しました...しかし、そうではありません....ツールは応答ヘッダーのみをチェックし、応答本文はチェックしていないようです。コンソールからの出力は次のとおりです。

dredd を使用して応答本文を確認できますか? どうすればこれを行うことができますか？

OAuth と複数のリビジョンの可能性と共に複数のクライアントで使用される Web サービスのバックエンドを構築するためのドキュメント ツールを検討してきました。私はすでに養蜂場について知っていましたが、少し調査を行ったところ、収益性の高い他のかなり優れたソリューションが見つかりました.

RAML は、優れたコード生成と API の再利用性を約束しているようです。しかし、モックサーバーを作成することはできないようです。また、apiblueprint を使用して REST API のクライアント側ライブラリとサーバー側スケルトンを生成できない理由がわかりません。

私たちにとって最良のユースケースは、コードを書くためのスケルトンを提供するノードエクスプレス/レスティファイアプリとともに、サービスを利用するためのクライアント iOS/Android/wp/js ライブラリを自動生成できる API のドキュメントです。API テストと負荷テストに加えて。

RAML/Swagger/Apiary のどのソリューションがこれに最適ですか?

API ブループリントでクエリ パラメータを文書化しようとしていますが、それが正しく行われたかどうか完全にはわかりません。リソースは次のようになります。

そのリクエストはユーザーを非アクティブ化しますが、次のリクエストはユーザー オブジェクトを削除します。

これは私が持っているブループリントのマークダウンです:

ただし、これを Apiary でレンダリングするとforce、パラメーターのリストにしか表示されませんが、サンプル URL に表示されるようになりました。GUIを誤解しているだけですか、それともクエリパラメータを別の方法で文書化する必要がありますか?