Skip to content

ADP

API Design PrincipleBETA

Main Navigation BETA & RFC 首頁常見問題 API檢查列表

繁體中文

English

繁體中文

English

Appearance

Sidebar Navigation

ADP綜合

0.ADP 概覽

1.ADP 目的

2.ADP 撰寫

3.ADP 編號

4.詞彙表

5.ADP 導入指南第一階段

API 治理

40.API 治理概述

41.API 版本控制

42.API 生命週期管理

43.API 限流

44.API 測試

45.API 監控

46.API 規範例外

47.API 認證和授權

48.API 健壯性

49.API 術語註冊

50.API 景觀

51.API 審查

52.API 健康檢查

53.API 作為產品

54.OAuth2.0/OIDC for API

HTTP 基礎

100.HTTP 基礎概述

110.HTTP 方法

111.GET

112.POST

113.PUT

114.DELETE

115.PATCH

117.PATCH 請求的 Content-Type

120.HTTP 標頭

121.常見的 HTTP 標頭

122.Accept

123.Authorization

124.Cache-Control

125.Content-Range

126.Content-Type

127.Deprecation

128.ETag

129.Expect

130.Idempotency-Key

131.If-Match

132.If-Modified-Since

133.If-None-Match

134.Last-Modified

135.Location

136.Prefer

137.Range

138.速率限制標頭

139.Retry-After

140.Sunset

141.User-Agent

142.X-Request-Id

143.Expires

144.Vary

145.Link

146.Accept-Post

147.Accept-Patch

148.Server

149.If-Unmodified-Since

150.Soft Deletion

151.Content-Disposition

200.HTTP 狀態碼

201.HTTP 狀態碼 504

202.Not Found v.s. Forbidden

HTTP 語意

350.HTTP 語義概述

351.範圍請求

352.條件式請求

353.內容協商

354.客戶端提示

355.帶偏好的請求

356.批次請求

357.長時間運行的任務

358.部分請求

359.部分回應

360.資源擴展

361.HTTP 快取

362.並發控制

363.自定義授權方案

364.自定義標頭欄位設計

365.自定義狀態碼

366.冪等性

367.HTTP Profile

368.HTTP Expect

369.HTTP 快取 ETag

370.HTTP 快取 Last-Modified

371.HTTP 快取 Cache-Control

372.伺服器發送訊息

373.伺服器端事件

374.WebSocket API 設計指南

375.使用 'expand' 展開資源

JSON 原則

700.JSON 設計概述

701.屬性設計

702.可枚舉值約定

703.日期時間和時間欄位慣例

704.ID 欄位慣例

705.名稱欄位慣例

706.null 和缺失的語義

707.日期時間和時間數據

708.時區數據

OpenAPI 原則

750.OpenAPI 設計概述

751.新的 OpenAPI 文件

752.OpenAPI API 受眾

753.OpenAPI x-rate-limit

754.OpenAPI JSON Schema

755.OpenAPI operationId

756.OpenAPI 提供示例

757.OpenAPI x-violated-adp

758.OpenAPI $ref

759.OpenAPI 聯絡資訊

760.OpenAPI webhooks

761.OpenAPI 公共共享架構

762.OpenAPI HTTP Profile 基礎

763.OpenAPI 隱式資源指示

764.OpenAPI 格式約定

765.OpenAPI 時區格式

766.OpenAPI 國家代碼格式

767.重複使用共享的常見 HTTP 標頭

768.可擴充列舉

769.OpenAPI 操作

770.OpenAPI 全面範例

REST 基礎

300.REST 概述

301.資源導向設計

302.URI 設計原則

303.乾淨清晰的 URL 路徑

304.集合的複數形式

305.相對 URI 路徑中的 API

306.URI 設計模式

307.啟發性 URI 設計集合

308.資源設計雜項

309.URI 格式約定

310.集合語義

311.過濾

312.分頁

313.排序

314.資源標識符

315.REST 成熟度

316.回應主要類型

317.JSON 回應

318.查詢參數慣例

319.請求主體慣例

320.陣列慣例

321.省略空值

322.超媒體替代方案

事件設計

600.事件設計概述

601.作為 API 設計一部分的事件

602.CloudEvents

603.CloudEvents 類型約定

604.CloudEvents 來源

605.CloudEvents 媒體類型

606.CloudEvents 測試標記

607.事件追蹤

608.臨時事件

609.事件分區

610.事件排序

611.事件嚴重性

612.事件記錄時間

工程原則

20.工程原則

21.最佳實踐

22.API 優先

23.開發者體驗

24.版本控制機制

錯誤設計

400.錯誤設計概述

401.HTTP 問題基礎

402.空白問題類型

403.問題類型設計

404.驗證錯誤設計

405.啟發性 HTTP 問題重新設計

406.啓發性問題類型集合

[ADP-770] OpenAPI 全面範例

Last updated:

Pager

Previous page769.OpenAPI 操作

Next page300.REST 概述

[ADP-770] OpenAPI 全面範例 ​

[ADP-770] OpenAPI 全面範例