YApi 与 postman

構造

インタフェースのドキュメントオーサリングツール

郵便配達

インタフェーステストツール

安らかなインタフェース仕様

残り

Representational State転送（状態遷移表属性）

コア：統一されたインタフェース仕様

仕様

ネットワーク上のすべてのものは資源として抽象化されます
各リソースには、一意のリソース識別子（書籍、車を）持っています
（など、XML、JSON、）様々な形態でのリソースと
すべての操作はステートレスです
CRUP（POSTをGETのPUT、DELETE）

が特徴の言い訳

APIキーを識別するURLとのインタフェース：
https://api.baidu.com
https://www.baidu.com/api
注：代理のURLリンク上の要求は完全な対話型のデータテーブルである前後に、APIの言葉を参照してください

これは、データリソースであります

データインターフェイスは、我々は、リソースを呼び出す前との相互作用後のデータの一般的完全なセットを、ある
https://api.baidu.com/users
https://api.baidu.com/books
https://api.baidu.com /ブック
注：一般的にリソースの複数形の使用を促進し、インセンティブが動詞運用リソース、URLリンクでのエラーのデモンストレーションを表示されません。https://api.baidu.com/delete-user

これらのインタフェースは、一般的に決定的なリソースを持っていないので、特別なインタフェースは、動詞を表示することができ、または動詞は、インタフェースで
のコアの意味
https://api.baidu.com/place/search
https://api.baidu.com/login

要求によって決定されたリソースの動作モード

一般的に操作リソースCRUDに関し、我々は要求操作CRUDを識別するための方法を提供します

https://api.baidu.com/books - GETリクエスト：すべての書籍を入手

https://api.baidu.com/books/1 - GETリクエスト：ブックの主キーを取得1

https://api.baidu.com/books - POSTリクエスト：ブックブックを追加

https://api.baidu.com/books/1 - PUT要求：主キー一体ブックを変更する1

https://api.baidu.com/books/1 -パッチ要求：ブック1の主キーの一部変更

https://api.baidu.com/books/1 -削除要求：1の本の主キーを削除します。

応答ステータスコード

私は前にブログを書かれています

応答結果

応答データは、ステータスコード、ステータス情報とデータ自体を持っています

{
 "status": 0,
 "msg": "ok",
 "results":[
 {
 "name":"肯德基(罗餐厅)",
 "location":{
 "lat":31.415354,
 "lng":121.357339
 },
 "address":"月罗路2380号",
 "province":"上海市",
 "city":"上海市",
 "area":"宝山区",
 "street_id":"339ed41ae1d6dc320a5cb37c",
 "telephone":"(021)56761006",
 "detail":1,
 "uid":"339ed41ae1d6dc320a5cb37c"
 }
 ...
 ]
}

URLは、リソースへのリンクへのアクセスを要求する必要がありますリソースのニーズを要求しました

{
 "status": 0,
 "msg": "ok",
 "results":[
 {
 "name":"肯德基(罗餐厅)",
 "img": "https://image.baidu.com/kfc/001.png"
 }
 ...
 ]
}

構造