1. 程式人生 > >淺談API介面設計

淺談API介面設計

    先宣告,本人也是剛接觸api介面這一塊沒多久,只是簡單地總結一下自己認識的API思想

    1.首先以tp框架來說,在框架裡面呼叫api的時候一般來說是需要去用file_get_contents或者curl亦或者snoopy來訪問這個url來獲取這個url對應檔案echo出來的資料,一般是json格式的資料。

    2.api檔案也就是url對應的檔案可以放在同一個框架裡面,這樣可以節省一個域名,只需要在本專案的域名下寫路徑url

    3.設計token進行傳參,在另外一邊的介面檔案進行token驗證,同時也傳一些我們呼叫介面時需要傳入的引數拼接成url

                


    4.在介面檔案進行token驗證,看是否相等,是的話進行呼叫方法訪問另外一個檔案的方法


    5.這裡呼叫了getKeyArtlist(引數1,引數2,引數3),來獲取資料

    6.在這個方法中可以進行一系列操作,不管是資料庫查詢還是如何程式碼邏輯處理,最後return資料出去

    7.return出來的資料在api第一個檔案進行接收並進行json_encode()打包成json資料echo出去

    8.這樣就請求到了api資料了

    總結:其實api不同於SDK的是api是一個線上的url訪問一個檔案,傳入加密token,token正確加上傳進去的資料進行json資料抓取,例如傳入新曆生日給一個api,這個api進行農曆轉換返回;而SDK檔案一般就是要移植到專案當中,進不進行驗證是一回事,可以說SDK是一個本地檔案,而api是線上的檔案,你通過url就可以進行執行檔案得到資料。至此總結完畢!拙見請見諒!