Controller
Controller 使用 複數形式 + Controller 來命名,例如 ProductsController,如果有多個單字就使用大駝峰命名,例如 UserRolesControllerAPI
url 使用 kebab-case 方式命名,一樣使用複數形式,並且依靠 HTTP Method 來區分功能:
取得全部使用者
GET /users
依照 user-id 取得指定的使用者
GET /users/{user-id}
新增使用者
POST /users
更新使用者
PUT /users
依據 user-id 刪除使用者
DELETE /users/{user-id}
appsettings.json
假設在 appsettings.json 中有 OpenApi 這個設定值
{
"OpenApi": {
"Enable": true
}
}
筆者喜歡使用 Settings 這樣的字眼來命名設定檔屬性對應的類別
public class OpenApiSettings
{
public bool Enable { get; set; }
}
持續更新中...
參考資料:
Microsoft.Learn - General Naming Conventions
感謝教學~
回覆刪除