程式設計師不得的不會的介面文件

程式設計師不得的不會的介面文件

一、傳統方式

我在工作中，是如何編寫介面文件的呢？接下來給大家聊一神器，驚喜在後面。

首先，我新建乙個專案，基於spring boot，開發幾個介面，發布執行。

編寫**，實現2個資料介面，乙個post請求，新增，乙個get請求實現查詢

執行專案，並測試介面

按照傳統方式，專案寫完了是不是要寫介面文件？傳統的介面文件就是如下所示：

介面：使用者資料查詢

請求方式：get

請求引數：無

返回格式：json

返回資料參考：

二、swagger

可是現在突然介面發生了變化？怎麼辦？是不是要去改動介面，再來改動文件？那麼今天咱們用swagger來介面資料介面改動對介面文件的影響。

swagger最受歡迎的rest apis文件生成工具之一，可以生成乙個具有互動性的api控制台，開發者可以用來快速學習和測試api。

那麼swagger如何應用？接下來三部曲：

依賴jar

配置註解

在對應的資料介面上使用以下註解：

@api修飾類 標記這個類是做什麼的

@apioption 修飾方法，標記這個對映方法是解決什麼問題的

啟用swagger

在springboot的開關類上使用註解@enableswagger2

重新執行專案，在瀏覽器訪問swagger-ui.html頁面，可以看到如下內容：

我們可以看到剛剛咱們寫的2個介面，請求方式、路徑、做什麼的是不是都可以清晰的看到？那麼我們再來進行下面的測試介面：

總結

程式設計師不得的不會的介面文件

程式設計師不得的不會的介面文件 一 傳統方式 我在工作中，是如何編寫介面文件的呢？接下來給大家聊一神器，驚喜在後面。首先，我新建乙個專案，基於spring boot，開發幾個介面，發布執行。編寫 實現2個資料介面，乙個post請求，新增，乙個get請求實現查詢 執行專案，並測試介面 按照傳統方式，專...

不會程式設計的程式設計師

ugmbbc發布於 2010 03 01 18 02 56 21446 次閱讀 字型 大 小 列印預覽 感謝東西的投遞 我想這讓人難以置信，但是通過twitter和電子郵件渠道蜂擁而來的報道表 明 許多參加程式設計師面試的求職者根本就不會程式設計，看看邁克 林最近的郵件就知道了 為啥程式設計師 都不...

那些讓程式設計師崩潰的瞬間《非程式設計師不得入》

聽說嫁人要嫁程式設計師，錢多話少脾氣好。這話多半是程式設計師自己誇自己的。程式設計師確實是極富幽默感的群體，善於自嘲，勇於自黑，耐受力超強，很多事可行可不行，不到不可忍絕不會衝冠一怒。不過，就是這麼 nice 的人，也很有一些受不了的事兒。8個讓程式設計師崩潰的瞬間！看到哪乙個你哭了？1 產品改需求...