eBay RESTful API ドキュメントの新しいデザイン

Buy、Sell、Commerce API ドキュメントが変わったことにお気づきですか? はい、この夏、UI を全面的に刷新しました。新しいデザインは、新しい RESTful API のモデルを反映するように調整されており、気に入っていただければ幸いです。

RESTful API モデル

API リファレンス ドキュメントの新しいレイアウトでは、さまざまな API とそれに関連するリソースの関係を明確に結び付けることで、RESTful モデルを強調しています。ナビゲーションを更新し、HTTP メソッドを色分けし、Buy、Sell、Commerce API コンテキストの配色を作成しました。これらの新しい色は、developer.ebay.com の最近の全体的な再設計と一致しています。完全に NodeJS によって駆動される新しい API リファレンス ドキュメントには、いくつかの機能的な変更も施されており、きっとご満足いただけると思います。

フィールド テーブルと呼び出しテーブル

以前の呼び出しインデックスを、リソースとメソッドの新しいインデックスに置き換えました。新機能の 1 つは、呼び出しリソース テーブルをメソッド名、HTTP メソッド、または呼び出しパスで並べ替えることができることです。これにより、コードに取り組んでいるエンジニア、一般的な要件を記述している製品マネージャー、または API Explorer などのツールを使用しているかどうかに応じて、リソースを自由に参照できます。メソッド テーブルとフィールド テーブルの新しいレイアウトを作成しました。テーブル列のサイズを変更し、表示する必要があるコンテンツを拡大できるようになりました。

リクエスト ペイロードとレスポンス ペイロード

ペイロード表示 (フィールド テーブルの上にあるリクエスト モデルとレスポンス モデル) を更新し、画面のスペースを節約しました。また、ペイロードをスクロールする機能を追加することで、表示する必要があるスキーマの任意の部分に焦点を絞ることができるようになりました。ペイロード全体を一度に確認する必要がある場合は、新しいクリップボードへのコピー機能を使用します。1 回のクリックで、表示されているペイロード モデルのすべてのコンテンツがコピーされます。

命名規則

REST モデルに重点を置くため、ドキュメントでは、API スキーマで定義されているメソッド名ですべてのメソッドを指すようになりました。この命名規則はサイト全体で標準化されており、API エクスプローラーやその他のツールでも同じメソッド名が使用されています。

ナビゲーション

街中でもドキュメント内でも、移動は重要です。そのため、ドキュメントのナビゲーションを完全に分解して再構築しました。ドキュメントの使いやすさを向上させるため、RESTful API ドキュメント全体でナビゲーションの一貫性を維持しました。各 API コンテキスト (販売と購入など) に高レベルのナビゲーションを実装することで、どこからでもリファレンス ドキュメント、統合トピック、eBay RESTful API の使用ガイドにジャンプできます。

また、左側のメニューも改善され、API リファレンスのすべての呼び出しページ間を移動できるようになり、API に関連するその他のすべてのドキュメント (インデックス、リリース ノート、統合ガイド、概要など) も移動できるようになりました。さらに、OpenAPI 仕様へのリンクも追加しました (利用可能な場合)。最後に、一部のユーザーから要望のあった機能を追加しました。読みたいページを見つけたら、左側のメニューを折りたたんで表示スペースを広げます。

フィードバックをお待ちしています

新しいドキュメント レイアウトに関するフィードバックをお待ちしています。改善のためのアイデアや提案があれば、コメント してください。

どうぞお楽しみください。
eBay 開発者ドキュメント チーム