Swagger 與 OpenAPI 規範培訓

介紹

API 定義

• 定義檔
• API 請求

YAML

• 什麼是YAML
• YAML 規則

RESTful 服務概述

• 資源
• 狀態傳輸
• 代表

準備開發環境

• 安裝和設定 Swagger
• 安裝和配置 Node.Js

REST Web 服務約束體系結構

• 使用 client-server 約束
• 使用統一的介面約束
• 使用無狀態約束
• 使用 HTTP 快取
• 啟用層次系統

REST API 設計

• 實施 CRUD 操作
• 使用錯誤處理
• 實現 REST API 的操作
• 處理 API 中的更改
• 版本控制 API
• 快取 API
• 支援分頁和部分回應

使用 Swagger 的規格

• 使用 Swagger 編輯文件
• 以 YAML 格式創建規範
• 創建路徑和觀測值
• 添加文件
• 向 OAS 檔添加 Schema
• 使用 SwaggerHub

API Management

• 創建 API 管理策略
• 管理 API 生命週期
• 生成 API 代理
• 控制 API 的行為
• 構建 API 門戶
• 提供流量管理

API 安全

• 使用令牌和 JWT 進行保護
• 使用 API 金鑰和金鑰進行保護
• 使用 OAuth2.0 進行授權

總結和結論