問題タブ [apiary]
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.
apiary.io - API 呼び出し時の Apiary エラー
Apiary で次のエラーが表示されます申し訳ありませんが、API 呼び出しに失敗しました。
私のホストは FORMAT: 1A HOST: https://test.mynetwork.com/として定義されています。
GET 呼び出しは次のように定義されます
データ壷 [models/v2/files/{urn}/data{?guid}]
ゲット [ゲット]
パラメーター
- urn (必須, 文字列,
ttt)...デザインの壷。 - guid (optional, string,
067e6162-3b6f-4ae2-a171-2470b63dfe02)...guid でフィルタリングします。
- urn (必須, 文字列,
応答 200 (アプリケーション/vnd.api+json)
- 本体データ { "バージョン": "1.0", }
これを呼び出すと、エラーが発生します。任意の入力
apiblueprint - JSON/JSONSchema をレンダリングできません。MSON 定義のオブジェクトのメンバ タイプが無効です
私は API ドキュメントを持っていますが、突然何の変更もなしにunable to render JSON/JSONSchema. Invalid member type of object in MSON definition、Response 200 (application/json) 行で検証アラートをスローし始めました。
私はそれをグーグルで検索しようとしましたが、何が間違っているのかわかりません。手伝ってくれてありがとう！
webhooks - Apiary/API ブループリントで Webhook を文書化する方法
apiary を使用して api のドキュメントを生成する api blueprint から始めたところです。REST API と多数の Webhook の両方があります。REST API は簡単に作成できますが、Webhook のドキュメントを生成する最善の方法がわかりません。
Webhook と REST API の間でデータ構造を共有したいと考えています。
これまでのところ、REST リソースと同じように Webhook を文書化することしか考えられません。通常、Webhook のドキュメントは単なるペイロード情報であるため、これは少し奇妙に感じられますが、おそらくそれが最良の選択肢です。
誰でもこれを行いますか？それとも、これを行うためのより良いツールがありますか?
最終的には、github のようなものが好きです: https://developer.github.com/webhooks/
apiblueprint - すべての Apiary/Blueprint API リクエストで共有ヘッダー セクションを指定するにはどうすればよいですか?
大きな API ドキュメントがあり、各リクエストには や のような同じリクエスト ヘッダーがAccept: application/jsonありCookies: SessionIDます。重複を避けるためにこれらをグローバルに宣言する方法はありますか?
apiary.io - apiary.io でコード スニペットを記述する方法は?
私は apiary.io を使用しており、すべての安らかなエンドポイントを追加しました。GET リクエストを作成して結果を取得する方法について、多くの言語でコード スニペットが提供されています。
ここで、どのエンドポイントにも関連しないコード スニペットをドキュメントに追加したいと思います (認証プロセスの例)。リンクをクリックせずに、このコードを右側に表示したい。どうにかしてこれを達成できますか？IDE のように、コードを強調表示してインデントしたいと思います。関連する場合は、Pythonを使用しています。
前もって感謝します！
apiblueprint - apiary CLI fetch コマンドを使用して apiary.apib を取得できません (自分の apiary アクセス トークンを使用しているにもかかわらず)
養蜂場のドキュメント (養蜂家サーバー上) をローカル ドライブに取得しようとしています。私は API の所有者であり、[設定] ボタンにアクセスできます (最終的に 403 禁止応答が返されるため、これはおそらく重要だと思いました。以下を参照してください)。
apiary CLIをインストールした後、次の手順に従いました。
注: Windows 上で実行されています (cmd/powershell を使用してコマンドを実行します)。
- ここから取得したアクセストークンを取得する
- 新しい環境変数 APIARY_API_KEY=Access token を設定します。
次のコマンドを実行します (apiary.io で API 名を簡単に見つけることができます)
/li>
APIドキュメント（これまでブラウザを介してapiary.ioで作業してきました）をローカルドライブにフェッチすることを期待しています-これにより、ローカルで編集して追加のツール（drdd）を実行し、フェッチしたドキュメントに対してAPIを検証できます.
代わりに、次の応答が返されます。
apiary.io で自分の API を簡単に表示/編集できるのに、apiary CLI を使用してアクセスできないのはなぜですか?
(編集済)画像追加
swagger - Swagger で content-type: text/html の Response Body に値の例を提供する方法 (dredd でテストするため)
200 OK を返し、HTML を返す API 呼び出しがあります。これを API ドキュメントに追加したいと思います (特に、dredd を使用して検証し、期待される応答本文を提供しない限り、テストは失敗します)。Swaggerでこれを行うにはどうすればよいですか?
--- 詳細 --- API 呼び出しに対する私の応答は 200 OK で、応答本文は 1 行です。
<html><body>You are being <a href="https://my.domain.com/users/sign_in">redirected</a>.</body></html>
Blueprint の Response Body は、次の形式で簡単に定義できます。
しかし、Swagger でこれを行う方法がわかりません。私が見つけることができるほとんどすべての例は、(当然のことながら) application/json 応答用であり、この種の応答の正しい構文を推測するのに苦労しています。
私のドキュメントの関連するswaggerテキストは次のとおりです（これまでのところ、応答本文を指定していないため、応答本文が である必要があるため、空の本文で dredd が失敗します<html><body>You are being <a href="https://my.domain.com/users/sign_in">redirected</a>.</body></html>）：
これについて何か提案があればコメントしてください。ありがとう！