問題タブ [apiary]

私が望むのは、API ドキュメントに関連付けられているメインのメールを変更することです。そのため、ドキュメントを他の人と共有すると、私のメールではなくその新しいメールが表示されます。その新しいメールには apiary.io が含まれているため、所有権の譲渡について話しているのです。

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

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

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

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

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

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

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