Skip to content

OpenAPI / Swagger Resource List for API Developers

OpenAPI / Swagger Resource List for API Developers

本文發表於 2017 中,簡單說明了使用 OpenAPI 的好處,並依主題整理 OpenAPI 相關的文章與工具。

使用 OpenAPI 帶來的三個好處:

  1. Generating interactive documentation - 可互動的 API 文件讓人更快理解如何使用
  2. Human readable and machine readable - 人機可讀及語言無關,讓任何語言的工具都可以操作它
  3. Creating SDK for multiple languages - Swagger CodegenOpenAPI Codegen 可以產生多種語言與框架的 server side、client side 程式碼

文內包括的議題:

  • Writing Spec / Design
  • Documentation
  • Generators
  • Servers
  • Clients
  • Testing & Monitoring
  • Gateways / Management
  • Public Specifications
  • Other Resources

部分連結可能因為時間關係已經失效,但透過這幾個議題來定位 OpenAPI 的功能也是一個不錯的介紹方法。

Comments