iT邦幫忙

鐵人檔案

2024 iThome 鐵人賽
回列表
IT 管理

我要成為文件工程師── Web API 文件撰寫 系列

我:「我不想寫文件!」
也是我:「為什麼沒有文件!」
既然不可能不寫文件,如何讓文件更好寫?本系列文將針對 Web API 的文件撰寫的一些方法與心得進行介紹。

參賽天數 12 天 | 共 12 篇文章 | 1 人訂閱 訂閱系列文 RSS系列文
DAY 11

[Day 11] TypeSpec:撰寫 OpenAPI 的領域特定語言 (五)

模型 使用關鍵字 model 建立模型,模型可以在不同的操作或其他模型中重複使用,編譯時模型會輸出在 components 節點,並在各個使用的地方透過 $r...

2024-09-24 ‧ 由 Kei Liao 分享
DAY 12

[Day 12] TypeSpec:撰寫 OpenAPI 的領域特定語言 (六)

模型 多型 接下來將使用在 [Day 06] OpenAPI:標準的 API 描述技術規範(五) 時相同的情境做說明。會員允許多種登入方式,而透過不同的登入方...

2024-09-25 ‧ 由 Kei Liao 分享