如何寫一個好的接口


1.try{}catch{} 中的exception:

   異常,不要吞掉,該throw的應該throw出來,由項目統一的ExceptionHandler統一處理

  盡量豐富throw出的exception信息

  日志記錄

2.webapi項目

  返回、傳參:類型明確,非object、IActionResult

    MVC項目,返回IActionResult

    利於,返回類型統一:調用者不會產生疑惑(string or  list<entity>)

    請求、響應是唯一的

  [ExceptionHandler or ResultHandler]來對項目的throw異常進行統一的處理

3.Proxy代理模式:

  1.對各個平台的調用屏蔽了細節。調用者不用了解不同平台的細節,可以很快實現相關功能

  2.隱藏了authentic的細節,防止外部調用者的錯誤操作,造成嚴重事故

4.注意項目的層次分明

  1.數據庫操作層

  2.外部api的代理層

  3.業務邏輯層

  4.分層、方法構建:

    考慮如何使調用者用最少的學習成本,來完成接口的調用,實現應有的功能

    層次多了 or 少了

    分層是否合理:架構、邏輯、業務

5.那些東西可以放在公共項目中:Common項目

  定義不會產生歧義的。產生歧義的(付款方、打款方,不同角色的理解不同)

  大家都會使用的公共的方法、類

    

  

  


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM