ASP.NET Web API - Route

Web API Routing

Web API 主要有 2 種 Routing 的方式
1.Routing Table
2.Attribute Routing

Routing Table

在 Default 中, Web API 使用的是 Route Table 的 Template
  • config.Routes 是一個 HttpRouteCollection 的 type, 主要是裝 Route Table
  • MapHttpRoute 是一個 function, 可以創造一個 IHttpRoute 的 instance 並且把以下的參數加入 config.Routes 裡面
WebConfig.cs
想要有自己定義一個 Route 也是沒問題的, 甚至還可以加入限制, 我這裡舉例的是如果我有 id, 那麼這個 id 一定要至少出現一次 0-9之間的數字
WebConfig.cs

Attribute Routing : configuration, adding constraint to route parameter

使用 [Route()] 來表示 Api 的 route, 可以使用在 Controller 或者是 Action 都可以
  • Configuration
    如果要使用 Attribute Routing, 就要在 WebConfig.cs 裡面 register config.MapHttpAttributeRoutes();
  • 在 Controller 裡面就可以這樣使用, 以下的這個 Route 會和 /api/employees 是一樣的
  • 這一個 Route 就會和 /api/employees/1 是一樣的

Route Prefix

可以看到上面 2 個例子都有 /api/employees, 那麼我們就可以用 RoutePrefix, RoutePrefix 顧名思義就是把相同的 String 放在 class的上面, 表示這一整個 class 是屬於 /api/employees, 那麼把每一個 function 所使用的 /api/employees 刪除就可以
  • 那麼突然有一天我想要 override 這一個 route 要怎麼辦? 只要在前面加上 ~就可以了
[RoutePrefix("api/books")]
public class BooksController : ApiController
{
    // GET /api/authors/1/books
    [Route("~/api/authors/{authorId:int}/books")]
    public IEnumerable<Book> GetByAuthor(int authorId) { ... }

    // ...
}
​

留言

張貼留言

這個網誌中的熱門文章

ASP.NET Web API - DTOs

圖片
大部分來說, 想要拿到 DB裡面的資料可以直接去 DB拿, 但是這樣會有缺點, 假設資料庫有密碼, 地址, 這一些比較隱密的資訊, 而且這一些資料並不需要透過 API 傳給其他的服務, 那麼直接去 資料庫拿資料就不會是一個好方法 所以DTO就是先過濾掉有需要的資料給其他的 Services,然後再把這一些資料給需要的 Clients 定義 A DTO is an object that defines how the data will be sent over the network. GET: AutoMapper 上面的例子是我們手動產生 DTO 的 class, 但是在真實世界中會用 AutoMapper 來自動產生我們所想要的 DTO ​
閱讀完整內容

Scaffold Identity into the Current Project

圖片
適用 .NET Core v3 1.打開SqlServer, 並在 DB run 以下這一個 script https://gist.github.com/akatakritos/96b0c3136f8498246fa810d393927f04 2.在 Models folder 裡面加入 ApplicationUser 和 ApplicationRole class 3.打開自己的 DBContext, 並且把繼承後面的 DBContext 改成 IdentityDbContext<ApplicationUser, ApplicationRole, string> , 並且在同一個 DBContext 檔案裡面, 下面的 method 是 OnModelCreating() , 在裡面加入 base.OnModelCreating(modelBuilder); 4.去 Startup.cs 的 ConfigureServices register 這一個 ApplicationUser 跟 ApplicationRole 5.去 _LoginPartial.cshtml inject ApplicationUser 6.最後執行這一段 script INSERT INTO AspNetRoles (Id, Name, NormalizedName) Values ('1', 'Administrator', 'Administrator'); INSERT INTO AspNetRoles (Id, Name, NormalizedName) Values ('2', 'Customer', 'Customer'); Insert INTO AspNetUserRoles (RoleId, UserId) (Select '1', Id from AspNetUsers); ​
閱讀完整內容

Passing data from controller to the view

圖片
ViewData : 是一個 key value 的 dictionary, key 的 data type 規定是 string, ViewData 的 life time value 只會存在這一個 current request ViewBag : 是一個 dynamic typed, 可以裝任何的 typed using set method, 也可以直接 get 裡面所裝的 object, life time 的 value 只會存在這一個 current request TempData : 跟 ViewData 一樣是 key-value dictoinary, 但是 life time value 會持續到 next request, 比較常用的是在 redirect 時要記得 model 的 state 使用方法: 可以把 ViewBag 的 key 叫做 Product, 並且 assign 一個 product object 給 ViewBag , 這裡只是使用方便, 所以直接 hardcode product, 一般的狀況要用 LINQ 去 database 拿資料, 並且在 assign 最後在 Views/Details.cshtml 來拿到這一個 ViewBag 裡面的東西 ​
閱讀完整內容