問題タブ [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.
attributes - オプションに設定されていても、Apiary の属性が常にドキュメントに必須として表示されるのはなぜですか?
次のように、データ構造セクションにオブジェクトを作成しました。
次に、適切なリソースで、リクエスト アクションでオブジェクトを使用します。
私のドキュメントでは、それが必要であることを示す下の画像のように常に表示されます(説明も表示されません)。ただし、生成された JSON スキーマでは、すべてが正常です。
これはバグですか、まだ完全にサポートされていない機能ですか、それともマークアップで何か間違ったことをしていますか?
parameters - URI パラメータが異なる [GET] リクエストとレスポンスの例
私は URI を持っています: /lessons/{language}/{type}
設計図に、さまざまなパラメーター {language} と {type} を持つモック リクエスト/レスポンスをもっと追加したいと考えています。これはGETメソッドでは不可能のようです。
私の考えは次のとおりです: GET /lessons/cs/easy は以下を返します:
そして GET /lessons/de/easy は以下を返します:
これは動作していない私の構文 (下) です。
プレビューではこんな感じ。
apiblueprint - 入力パラメータがApiaryの日付/時刻であることを示すための正しい形式は何ですか?
私が取り組んでいるプロジェクトでいくつかの Apiary ドキュメントを編集しており、API 呼び出しの 1 つへのパラメーターが日時文字列であることを示す必要があります。Apiary はこのパラメーターの書式設定を窒息させているように見えるので、Apiary でこのパラメーターを文書化するための提案されたアプローチはどうなるのだろうと思っています。
実証するために、Apiary から標準のデフォルト ドキュメントChoice
を取得し、次のように日時オブジェクトを取得するようにドキュメントを変更しました。
この最終結果は次のテキストです。
これは明らかに間違っています。例の値を書き留めても問題ありません。ダッシュ ( -
) は、ここで問題を引き起こしている特殊文字です。これを正しく行うための推奨されるアプローチは何ですか?
apiblueprint - apiary で json 投稿パラメーターを定義する
JSON 投稿リクエストを使用してプロジェクトのドキュメントを作成しようとしています。
get リクエストでは、uri パラメータを簡単に定義できます。
ただし、json やその他の投稿リクエストについても同じことを行いたいと考えています。
私はそれが以下のように機能することを望んでいました.例にパラメータを表示しますが、それを行う方法ではないようです...
これを適切に行う方法はありますか?
apiary.io - 応答リターンを制限する Apiary
そのため、Apiary を使用してデータの配列を保持し、データを呼び出して HTML に表示していますが、Apiary が完全な配列ではなく、限られた量のデータのみを HTML に送信するようにしたいと考えています。まだ Apiary の構文について頭を悩ませているので、正しい方向に進んでいるかどうか (または、フロントエンド経由でこれを行うのでしょうか?) を疑問に思っています。私には明らかです:
apiblueprint - API ブループリント / MSON でパターンを使用する
API ブループリント、特に MSON の新しいデータ構造構文の可能性を調査しています。パターン(正規表現)のようなものを添付または指定することは可能ですか?このトピックについては何も見つかりませんでした。
apiary - Apiary ブループリントを「所有」しているのは誰ですか?
apiary.io で青写真を作成し、Editor
他の数人に権利を付与した場合、「私」についての特別な点は残っていますか?
もしそうなら、どうすれば誰がbpを「所有」しているかを知ることができますか?
特に、私はいくつかの電子メール アドレスに対して Apiary アカウントを作成し、それらをすべて編集者にしました。CLI (github: apiaryio/apiary-client) を使用しようとしています。複数の「Editor」アカウントに対して (login.apiary.io/tokens で) 生成されたトークンを使用すると、「403 Forbidden」と表示されます。CLI を試す「真の所有者」アカウント (明らかに忘れてしまった) を選択するにはどうすればよいですか?
rest - Apiary.io や API ブループリントは API のバージョン管理をサポートしていますか?
API ブループリントまたは Apiary.io は、API のバージョン管理の概念をサポートしていますか? 特に、次のように URI を介して API をバージョン管理しています。
上記の例では、API のバージョン 2 (「v2」) を呼び出していることを意味します。APIブループリントはこれをサポートしていますか? 特定のアクションまたは API 全体の複数のバージョンを文書化するにはどうすればよいですか?