インタフェース仕様
ウェブAPIインタフェースとは何ですか
媒体は、本質的に、URLリンク仕様に沿ったものである前後端、交換情報から分離された後
ウェブAPIインターフェイスはシンプルには、次の4つの特性のようにまとめることができます:
- URL:リンクバックデータのようなURLルックス
- リクエストメソッド:GET、POST、PUT、DELETE、パッチ...
- リクエストパラメータ:KVフォーム要求のリンクパラメータを運びます
- サーバから返されたデータが終了した後、JSON形式のような要求:応答結果を
インターフェイスのドキュメントの準備:YAPI
私たちの仕事では、我々は、他の同僚と、独自のインタフェースごとに書かれた説明を通信する必要があり、その後、あなたはYAPI、オープンソースのビジュアルインタフェース管理プラットフォームを使用することができます。
郵便集配人:テストツールのインターフェイス
郵便配達は、デバッグツールのインターフェースで動作するさまざまなプラットフォームをサポートしながら、フリー可視化ソフトウェアで、インターフェースをテストするために好適なツールです。
安らかなインタフェース仕様
URLデザイン
- セキュリティデータは:
HTTPSプロトコルは、一般的に伝送のために使用されるURLは、httpプロトコルは、HTTP上のプロトコルでカプセル化されています - :インタフェースの性能特性
を持つapi
キー識別インタフェース - 共存の複数のデータバージョン:
識別データ接続のバージョン、
https://api.baidu.com/v1
https://api.baidu.com/v2 - 資源であるデータ:
インターフェースは前と相互作用した後のデータの一般的完全なセットで、我々は、インタラクティブなデータリソースを呼び出し、リンクなどのデザインの形で一般的な負の資源を推進し、動詞操作リソースが発生しないことがありますが、また、特別な動詞が発生する可能性があります。 - リソース操作は、利用要求方法に決めた:
GET:取得
増加:ポスト
プットを:全体は、データ変更
、データの局所的な変更:パッチ
の削除を:指定されたデータを削除
応答ステータスコード
200:一般要求
201:成功を作成します
301:永続的なリダイレクト
302:一時的なリダイレクト
403:無許可要求
404:要求パスが存在しません
405:要求メソッドが存在しません
500:サーバーの異常
応答結果
データは、応答ステータスコード、状態情報、およびデータ自体を持っています
{
"status": 状态码,
"msg": 状态信息,
"results": { 响应数据 }
}