WebApiはカスタムルーティングとBaseControllerを使用

8202 ワード

新しいBaseControllerを作成し、ApiControllerから継承

public abstract class BaseController : ApiController
    where T : class, IApiModel
{
    [HttpPost]
    [Route("")]
    public abstract Task Insert([FromBody] T model);

    [HttpPut]
    [Route("")]
    public abstract Task Update([FromBody] T model);

    [HttpDelete]
    [Route("{autoId:int}")]
    public abstract Task Delete([FromUri] int autoId);

    [HttpGet]
    [Route("")]
    public abstract Task> GetAll();

    [HttpGet]
    [Route("{autoId:int}")]
    public abstract Task GetById([FromUri] int autoId);

    [HttpGet]
    [Route("GetPage")]
    public abstract Task> GetPage([FromUri] PageOption option);
}

public class PageResult
    where T : class
{
    public int Count { get; set; }

    public IEnumerable Items { get; set; }
}

public class PageOption
{
    public int CurrentPage { get; set; }

    public int Top { get; set; }
}

新しいUserController、BaseControllerの継承

[RoutePrefix("api/users")]
public class UserController : BaseController
{
    public override Task Delete([FromUri] int autoId)
    {
        throw new NotImplementedException();
    }

    public override Task> GetAll()
    {
        throw new NotImplementedException();
    }

    public override Task GetById([FromUri] int autoId)
    {
        throw new NotImplementedException();
    }

    public override Task> GetPage([FromUri] PageOption option)
    {
        throw new NotImplementedException();
    }

    public override Task Insert([FromBody] User model)
    {
        throw new NotImplementedException();
    }

    public override Task Update([FromBody] User model)
    {
        throw new NotImplementedException();
    }
}

public class User : IApiModel
{
    public int AutoId { get; set; }

    public string Name { get; set; }
}

以上のコードには2つの特性が使われています.1つはRoutePrefix、もう1つはRouteです.http://xxx/api/usersなどのアドレスでアクセスできますが、プロジェクトを実行すると、WebApiConfigで構成する必要があるため、エラーが報告されていることに気づきました.
public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API  

        // Web API  
        config.MapHttpAttributeRoutes(new CustomDirectRouteProvider());

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
    }
}

public class CustomDirectRouteProvider : DefaultDirectRouteProvider
{
    protected override IReadOnlyList GetActionRouteFactories(HttpActionDescriptor actionDescriptor)
    {
        return actionDescriptor.GetCustomAttributes(true);
    }
}

上のコードから分かるようにconfig.MapHttpAttributeRoutes(new CustomDirectRouteProvider()); カスタムルーティングを使用して、構成が完了すると、GETとPOSTメソッドにアクセスできます.PUTとDELETEは?IISのデフォルトではPUTやDELETEへのアクセスは許可されていないため、Webで行う必要がある.configで再構成
<system.webServer>
    <handlers>
        <remove name="WebDAV" />
    handlers>
    <modules>
        <remove name="WebDAVModule"/>
    modules>
system.webServer>

上のコードのようにhandlersとmodulesの2つのノードにWebDAVとWebDAVmoduleを削除すればよい