導語：談談restful風格API編寫和接口調用，推薦給前端開發人員使用的API接口
談談restful風格API編寫和接口調用
前言
前后端分離開發已成為主流，專業人做專業事，明確各自的分工有利于提高工作效率。然而實際開發過程中，卻受到一些因素的影響。比如接口代碼不規范、后端接口不自測、前端傳參錯誤、后端返參問題等等，往往耗費了大量的時間在接口聯調上，導致工作效率比較低下。有沒有好的方式去提高效率呢，下面就來說說編寫restful風格API和swagger接口調用
restful風格接口
簡介
Restful風格API是一種軟件架構、設計風格，不是標準，只提供一組設計原則和約束條件。用于客戶端與服務器進行交互。基于該風格設計的軟件可以更簡潔，更有層次，更易于實現緩存等機制。
在 Restful 風格中，用戶請求的url使用同一個url而用請求方式：get、post、delete、put方式對請求的處理方法進行區分，這樣可以在前后臺分離式的開發中使得前端開發人員不會對請求的資源地址產生混淆和大量的檢查方法名的麻煩，形成一個統一的接口。
非Restful風格弊端
1、大量方法名，多個開發項目命名混亂
2、GET和POST請求方法使用混亂，有些方法不聲明具體方式，有時請求會報錯
3、不夠簡潔，每個接口都需要命名且不能復用
實現方式
SpringMVC 的 resturl 是通過 @RequestMapping 及 @PathVariable annotation 提供的，通過如
@RequestMapping(value=”/blog /{id}”,method=RequestMethod.DELETE) 即可處理 /blog/1 的 delete 請求。
GET(查詢)：從服務器查詢，可以在服務器通過請求的參數區分查詢的 方式。
POST(創建)：在服務器端新建一個資源，調用 insert 操作。
PUT(更新)：在服務器端更新資源，調用 update 操作。
PATCH(更新)：在服務器端更新資源(客戶端提供改變的屬性)，很少使用
DELETE(刪除)：從服務器端刪除資源，調用 delete 語句。
swagger接口文檔
簡介
swagger接口文檔由后端集成，可自定義掃描的接口類，能生成瀏覽器可直接訪問的接口文檔，接口名稱、入參、回參一目了然，前提是后端添加相關注解，既方便自己接口調試，也方便前端調用接口，本文重點介紹swagger實用的注解，至于集成方法可自行百度
注解
用于controller類上
@Api：對請求類的說明tags
屬性：說明該類的作用
用于方法上面
@ApiOperation：方法說明
value：說明方法的作用(可省略)
@ApiImplicitParams、@ApiImplicitParam：方法參數說明@ApiImplicitParam用于指定單個參數的說明
name：參數名
value：參數說明
required：參數是否必填
dataType：參數類型
defaultValue：參數默認值
對象類
@ApiModel：用在JavaBean類上，說明JavaBean的 用途
@ApiModelProperty：用在JavaBean類的屬性上面，說明此屬性的含義
value：字段說明
name：重寫屬性名字
dataType：重寫屬性類型
required：是否必填
example：舉例說明
hidden：隱藏
結尾語
restful風格API可通過注解明確CRUD使用的方法，約定數據傳輸格式，減少接口命名。swagger在線文檔可使用相關注解明確接口作用及入參示例，便于自測與聯調。實際開發過程中，可以加快接口聯調速度，提升工作效率。
推薦給前端開發人員使用的API接口
API接口正在變得越來越重要，隨著前后端的分離，前后端之間的交流就是通過API來進行溝通。如果你想要你的網站的內容是動態的，那么你就需要使用API來獲取內容。作為一個前端，我們只需要有接口API，我們就能讓我們的網站變得異常生動。
TMDB API
如果我們正在創建一個電影APP，那么The MovieDB API 絕對是我們最佳的選擇，它提供了非常多的電影數據，包括電影的海報，演員，圖片等等，它還有一些電視劇集，總之，通過它的API，你可以讓你的應用變得有趣起來，而且它提供的API是免費的哦。
The NASA API
如果你是一個天文愛好者，想要開發一個天文app，那么NASA api絕對是你的首選。 它有著豐富的數據，關于天文的信息，關于月球，太陽，其他星球的知識，總之，關于天文的信息，你都能通過這個API獲取到，而且它有著豐富的圖庫，可以讓你的APP變得栩栩如生。
Frankfurter
如果你對經濟學感興趣，想開發一個關于貨幣走勢的APP，那么Frankfurter將會是一個不錯的選擇，這個API是由歐洲中央銀行開發的，因此它的數據絕對真實可靠，此外它還是開源的，因此你可以隨意使用它。
The MealDB API
如果你是個吃貨，或者說你是個美食家，想要開發一個關于美食的APP，但是你又沒有精力收集各種食品的圖片和相關信息的話，那么MealDB API就是你的最佳選擇，這個API可以給你提供隨機的食物和菜單，它不僅可以提供給你食物的做法和步驟，同時還會提供精美的圖片，此外，它還會提供美食視頻，總之，這是一個美食APP不可多得的API。
Count API
一個計數API，你可以用它來做很多事情，比如統計訪問量，統計按鈕點擊次數，總之，只要有計數的地方，你都可以使用它，它就像一個計數數據庫，你可以隨時訪問它。
FreeToGame API
如果你對游戲感興趣，是一個資深游戲迷，想要開發一個游戲APP，那么FreeToGame API是一個不錯的選擇，它提供了豐富的游戲資源，你可以通過API獲取到不同類型的，不同平臺的游戲資源。
總結
其實網上有很多免費的API接口可以供我們使用，這些免費的接口足以讓我們開發出一些精美的APP出來。永遠不要抱怨我沒有這個資源，我沒有那個資源，有些東西都是需要自己去尋找的。
當然，如果你想要做一個屬于自己的，并且出色的APP出來，你最后還是需要有自己的API接口，你可以使用nodejs做后端來自己搭建，當然也有一些云廠商提供了圖形界面的api搭建工具，你需要做的就是盡可能地嘗試，只有你不停地努力，你才會變得越來越好，你才會有機會變得越來越好，不要抱怨機會沒有眷顧你，先看看自己是否有努力地去爭取過機會。
途傲科技為中小企業提供網站制作、網站建設、微信H5、微信小程序，多商戶平臺，多級分銷系統，APP開發，手機網站，HTML5多端自適應網站，營銷型企業站建設，及對技術人才的培養等都積累與沉淀了豐富的心得和實戰經驗。
如果您有想法，可以將需求提交給我們【免費提交需求，獲取解決方案】
免責聲明：文章部分內容收集于互聯網，不代表本站的觀點和立場，如有侵權請聯系刪除。
