在Debian上設計Swagger API,需遵循以下規范:
info
中定義API標題、版本、描述等元數據;用host
指定服務主機和端口,basePath
設置API路徑前綴;在schemes
中聲明支持的協議(如http
、https
)。paths
中定義API路徑,每個路徑支持多種HTTP方法(如GET
、POST
等)。為每個操作提供summary
、description
,明確參數類型(路徑、查詢、請求體等)、是否必需,以及響應狀態碼和數據結構。definitions
或components
(OpenAPI 3.0+)定義可重用的數據模型,明確屬性的數據類型、格式、是否必填等信息,可通過$ref
引用。securityDefinitions
中定義認證方式,如API密鑰、OAuth2等,并在操作中引用。