鐵人檔案
我：「我不想寫文件！」
也是我：「為什麼沒有文件！」
既然不可能不寫文件，如何讓文件更好寫？本系列文將針對 Web API 的文件撰寫的一些方法與心得進行介紹。
我：「我不想寫文件！」也是我：「為什麼沒有文件！」身為一個 Web 後端工程師，既然不可能不寫文件，如何讓文件更好寫？本系列文將針對 Web API 的文件撰...
昨天探討了 Web API 文件要有的內容，OpenAPI 提供了標準化的規範，讓開發者能夠以 json 或 yaml 格式來描述 API 規格。不少開發者都...
完成服務的基本描述後，就可以針對各支 API 內容進行撰寫了。同樣以虛構的會員服務為範例，以下是一支「取得單一會員資訊 API」的 OpenAPI 規格： #...
OpenAPI 的資料型別(type)是基於 Json 擴充，基礎型別有 boolean、integer、number、string......等，並可藉由...
在多數的情境下，不會獨立存在一支 API，而是由一組 API 來對領域或資源進行存取，以會員服務來說，會有一組包含：註冊、異動、註銷、取得單筆、查詢多筆......
一般在做 API 設計時，都會盡量收斂設計，期望一組 API 不用太多支，每支 API 參數和欄位不要太複雜，希望這些 API 可以像最經典的樂高積木一樣小而...
手刻 yaml 或 json 文件讓寫 OpenAPI 文件相當不方便，透過 Swagger Editor 或 Stoplight 等 UI 輔助工具是一種選...
在開始之前，先簡單介紹一下昨日我們建立的專案及基本操作。初始化 TypeSpec 專案時產生的 main.tsp 檔是 TypeSpec 的預設進入點，CLI...
命名空間 在 TypeSpec 中可使用命名空間 namespace 來分類類型，透過這樣的方式可以組織不同類型，也可以避免命名衝突，範例程式碼如下： nam...
今天將介紹 TypeSpec 的基礎型別，接著說明如何將其使用在操作的參數和回傳中。 型別 數值 和 OpenAPI 一樣，TypeSpec 支援許多不同的數...
