讓你在 API 設計中少踩坑的實戰分享

2021-08-18 15:26:06 字數 483 閱讀 5054

在專案開發中,實際的編碼只占用了整個專案不到 30% 的時間,更多的時間都耗在了需求分析與介面設計上。每一次的需求變更就可能涉及到多個 api 的修改,那麼 api 設計書作為專案開發的核心文件,如何才能讓前端和移動端開發人員更快的理解引數的意義和作用、適應版本更新,以及保障資料的安全性呢?本場 chat 將從以下幾個方面進行分析說明:

api 設計文件的規範,要怎麼寫清晰明了

api 如何命名

如何做好 api 的版本控制,如何應部分 api 版本更新

如何防止資料被篡改

token 方式的優缺點以及優化

jwt 加密方式的使用場景

為何推薦在過濾器層做許可權校驗,以及如何使用 shiro 作為許可權校驗

為何不推薦使用***

許可權攔截的白名單規則

閱讀全文:

對接釘釘API踩過的坑

1.呼叫批量傳送單聊訊息介面 2.呼叫場景 送釘釘互動式動態卡片 1 先是返回了錯誤提示 需要我開通智慧型人事的許可權,第二天發現申請智慧型人事許可權審核失敗,又嘗試再次呼叫了介面,居然通了!2 介面通了後返回機械人不存在的錯誤id,但我所使用的場景群機械人id在呼叫場景 送普通資訊介面時是沒問題的...

實戰裡踩過 jQuery 的那些坑

我是先學習的原生 js,只拿過原生 js 寫過一些簡單的小練習。在做實際專案時,使用 jquery 但是因為沒有系統學習過,而是以專案驅動學習,用到哪,查到哪,經常會踩到一些坑,在此一併記錄,希望自己以後不會再在同乙個問題上栽跟頭。jquery ajax 缺省會給傳入的 data 進行 url 編碼...

springCache配置中踩的坑

專案基於springboot,使用了springcache。早先在網上找了乙份springcache的配置,後來由於需要使用到自定義序列化方法,注入乙個自定義的序列化類。但是在後來發現自定義的序列化類始終沒有呼叫,後來檢視原始碼後終於發現了原因 先附上正確的配置 bean public cachem...