技術問答
技術文章
iT 徵才
Tag
聊天室
2023 鐵人賽
登入/註冊
問答
文章
Tag
邦友
鐵人賽
搜尋
第 12 屆 iThome 鐵人賽
DAY
7
2
影片教學
想盡辦法當好一個Junior Backend Developer
系列 第
7
篇
Golang - 如何當好一個junior backend developer - 談談為何需要API Document
12th鐵人賽
肯尼攻城獅
團隊
不要搶我隊友
2020-09-20 20:25:05
3114 瀏覽
分享至
為什麼需要API Document
需求來了
前後端需要同時開工 後端先寫好API
雙方溝通的文件
何謂API Blueprint
特點
線上寫API文檔的平台
使用Markdown語法撰寫
支援團隊協作
支援Mock Server 方便前端可以透過Mock Data先做
支援版本管理(GitHub)
也可以local運行
缺點
存檔需手動存擋
線上寫文檔UI的反應有點慢
沒有所謂的codegen的tool
何謂Swagger
特點
API的開發工具
Swagger使用OpenAPI規範, 這個規範由 Linux 基金會主持,是為了建立世界各地共通的 API 規範。
使用語法可以用YAML或者JSON
Swagger延伸出來很多工具,例如:Swagger UI, Swagger Editor, Swagger Codegen, Swagger Hub
Swagger UI可以拿來自己本地deploy 自己維護API document server
Swagger Editor 為線上的編輯器
Swagger Codegen 自動產生Client 跟Server 的code 拿去當作Mock Server也可以
Swagger Hub 線上文檔平台 提供類似於API Bluepirnt的服務
Swagger的生態性相對於API Blueprint豐富很多 找解答會比較好找
針對Swagger Hub來說
UI等操作性比API Blueprint好
但免費版的只支持個人 團隊協作需要花錢
API Blueprint則是團隊開發可以免費 但有限制數量
總結
一開始的小團隊可以使用API Blueprint工具 整體來說還是比較輕量化
等到前後端都開發成熟後 可以考慮慢慢轉換到Swagger 可控性會更高
這次先用API BluePrint示範 有時間就用Swagger改寫
歡迎參觀團隊其他成員的文章~
前端工程師一起來種一棵後端技能樹吧!
用舒服的姿勢開發 Python Project
留言
追蹤
檢舉
上一篇
Golang - 如何當好一個junior backend developer - 來設計貓咪平台的schema吧
下一篇
Golang - 如何當好一個junior backend developer - 介紹如何操作API Blueprint及好用之處
系列文
想盡辦法當好一個Junior Backend Developer
共
13
篇
目錄
RSS系列文
訂閱系列文
15
人訂閱
9
Golang - 如何當好一個junior backend developer - 介紹如何撰寫API Blueprint 其實就是MD語法啦!
10
Golang - 如何當好一個junior backend developer - API Blueprint想要Local開發並且架設自己的API Document Server
11
Golang - 如何當好一個junior backend developer - 來認識Gin框架!
12
Golang - 如何當好一個junior backend developer - 講解Gin的簡單範例!
13
Golang - 如何當好一個junior backend developer - CRUD與Binding介紹!
完整目錄
直播研討會
{{ item.subject }}
{{ item.channelVendor }}
{{ item.webinarstarted }}
|
{{ formatDate(item.duration) }}
直播中
立即報名
尚未有邦友留言
立即登入留言
iThome鐵人賽
參賽組數
1123
組
團體組數
52
組
累計文章數
23096
篇
完賽人數
656
人
看影片追技術
看更多
{{ item.subject }}
{{ item.channelVendor }}
|
{{ formatDate(item.duration) }}
直播中
熱門tag
看更多
15th鐵人賽
13th鐵人賽
14th鐵人賽
12th鐵人賽
11th鐵人賽
鐵人賽
2019鐵人賽
2018鐵人賽
javascript
2017鐵人賽
python
windows
php
c#
windows server
linux
css
程式設計
react
vue.js
熱門問題
公司有人常常亂改IP位置(想問有甚麼辦法可以將IP鎖住不給更改)
請問如何在老Tiptop系統,要新建一家公司要怎麼做?
DDR3記憶體 只抓到一半
發現生產厲害的傳統產業,資訊化越厲害,生產能力反而降低?
和朋友討論不出來 ,關鍵字搜尋方法,我也想學EXCEL了
請問我晚上開發一款工具,早上給公司使用,沒特別條款,法律知識產權還是我的嗎?
免安裝版軟體開啟權限問體
請教外網如何連到家裡內部裝置
Nessus 弱掃問題
API網址列 網址問題
熱門回答
公司有人常常亂改IP位置(想問有甚麼辦法可以將IP鎖住不給更改)
Alma Linux與Rocky Linux,選擇哪一個比較好?
DDR3記憶體 只抓到一半
請問公司網路通暢,卻部分固定的使用者無法連到特定網頁 ,求救~~~
和朋友討論不出來 ,關鍵字搜尋方法,我也想學EXCEL了
熱門文章
【資安日報】4月17日,多個廠牌的VPN系統、網路設備遭到鎖定,攻擊者對其發動暴力破解攻擊 Vigor Router Firewall 路由器 防火牆 解法
適合程式開發人員去練功夫
在任何雲端上運行:雲端的可移植性你有考慮過嗎?
筆電Wifi不見後, 筆電該怎麼上網?
量子計算「基礎」3. 量子操作
IT邦幫忙
×
標記使用者
輸入對方的帳號或暱稱
Loading
找不到結果。
標記
{{ result.label }}
{{ result.account }}