openapi

07
Jun

HTTP API: 該如何管理一份很大的OpenAPI document?

OpenAPI的document文件可以變得非常大一份,特別是當你有好幾百個routes的時候, 這時候單一份的yaml檔管理起來可能會非常頭大,這篇文章將分享在這種情況下, 我是如何將一份大的檔案拆分成許多小的檔案,易於管理。 OpenAPI Specification OpenAPI也被稱為Swagger,是一個用來描述你的API的標準,可以根據這個標準來撰寫你的文件, 我想你應該很熟悉了,如果還不熟的, 可以先看看官方的說明: OpenAPI specification。 我如何拆分檔案 使用JSON格式 官網上的範例文件都是使用yaml,而我偏好使用JSON,
3 min read
09
Apr

如何開始開發你的API: API first principle and OpenAPI

開發API應該要使用怎樣的流程,先定義好介面有哪些好處,以及可以使用哪些工具呢?(OpenAPI 3.0)
2 min read