【推薦】什么是文檔歸檔?

V5.2.3版本后,ApiPost開始支持“文檔歸檔”。

什么是文檔歸檔?

在ApiPost之前的版本里,一直有一個很難受的問題困擾者我們和使用者:當(dāng)我們把文檔的分享鏈接分享出去之后,由于文檔和當(dāng)前操作的接口數(shù)據(jù)是實時一致的,導(dǎo)致很多時候,后端人員一不小心的保存就會造成前端文檔的更改。

為了避免此情況的發(fā)生,我們在上個版本(V5.2.1和5.2.2)做了一個嘗試:把接口保存和文檔保存分開,接口保存不會保存文檔。但是造成的后果就是:明明我們的目錄有數(shù)據(jù),因為沒有點擊文檔保存,導(dǎo)致分享數(shù)據(jù)的文檔鏈接就是沒有數(shù)據(jù),或者,每次我新建一個接口都需要重新保存接口并保存文檔,增加了用戶的操作成本。

于是,經(jīng)過我們團隊的激烈探討,V5.2.3版本起,定下了這個方案:文檔歸檔機制。

所謂“文檔歸檔”是指,此文檔一旦被歸檔,那么前端展示的文檔就是歸檔那個時刻的文檔快照,不會隨著客戶端的臨時修改導(dǎo)致的接口保存而改變。未歸檔的情況下,文檔頁面仍是實時文檔。

怎么查看并管理已歸檔文檔?

通過點擊歸檔文檔管理查看并管理,一旦取消歸檔后,文檔頁回到實時模式。

附:ApiPost簡介:

ApiPost是一個支持團隊協(xié)作,并可直接生成文檔的API調(diào)試、管理工具。它支持模擬POST、GET、PUT等常見請求,是后臺接口開發(fā)者或前端、接口測試人員不可多得的工具 。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容