ApiController Kelas

Definisi

Ruang nama:

System.Web.Http

Rakitan:

Microsoft.AspNetCore.Mvc.WebApiCompatShim.dll

Paket:

Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.2.0

Sumber:

ApiController.cs

Menentukan properti dan metode untuk pengontrol API.

[Microsoft.AspNetCore.Mvc.Controller]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiActionConventions]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiOverloading]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiParameterConventions]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiRoutes]
public abstract class ApiController : IDisposable

[<Microsoft.AspNetCore.Mvc.Controller>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiActionConventions>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiOverloading>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiParameterConventions>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiRoutes>]
type ApiController = class
    interface IDisposable

Public MustInherit Class ApiController
Implements IDisposable

Warisan

Object

ApiController

Atribut

ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute

Penerapan

IDisposable

Konstruktor

ApiController()

Menentukan properti dan metode untuk pengontrol API.

Properti

ActionContext	ActionContextMendapatkan .
Context	Mendapatkan konteks http.
ControllerContext	Mendapatkan atau mengatur ControllerContext.
MetadataProvider	IModelMetadataProviderMendapatkan .
ModelState	Mendapatkan status model setelah proses pengikatan model. ModelState ini akan kosong sebelum pengikatan model terjadi.
ObjectValidator	Mendapatkan atau mengatur IObjectModelValidator.
Request	Mendapatkan atau mengatur pesan permintaan HTTP.
Url	Mendapatkan pabrik yang digunakan untuk menghasilkan URL ke API lain.
User	Mendapatkan atau mengatur prinsipal saat ini yang terkait dengan permintaan ini.

Metode

BadRequest()	BadRequestResult Membuat (400 Permintaan Buruk).
BadRequest(ModelStateDictionary)	InvalidModelStateResult Membuat (400 Permintaan Buruk) dengan status model yang ditentukan.
BadRequest(String)	BadRequestErrorMessageResult Membuat (400 Permintaan Buruk) dengan pesan kesalahan yang ditentukan.
Conflict()	ConflictResult Membuat (409 Konflik).
Content<T>(HttpStatusCode, T)	NegotiatedContentResult<T> Membuat dengan nilai yang ditentukan.
Created(String, Object)	CreatedResult Membuat (201 Dibuat) dengan nilai yang ditentukan.
Created(Uri, Object)	CreatedResult Membuat (201 Dibuat) dengan nilai yang ditentukan.
CreatedAtRoute(String, Object, Object)	CreatedAtRouteResult Membuat (201 Dibuat) dengan nilai yang ditentukan.
Dispose()	Melakukan tugas yang ditentukan aplikasi yang terkait dengan membebaskan, merilis, atau mengatur ulang sumber daya yang tidak dikelola.
Dispose(Boolean)	Merilis sumber daya tidak terkelola yang digunakan oleh objek dan, secara opsional, merilis sumber daya terkelola.
InternalServerError()	InternalServerErrorResult Membuat (500 Kesalahan Server Internal).
InternalServerError(Exception)	ExceptionResult Membuat (500 Kesalahan Server Internal) dengan pengecualian yang ditentukan.
Json<T>(T)	JsonResult Membuat (200 OK) dengan nilai yang ditentukan.
Json<T>(T, JsonSerializerSettings)	JsonResult Membuat (200 OK) dengan nilai yang ditentukan.
Json<T>(T, JsonSerializerSettings, Encoding)	JsonResult Membuat (200 OK) dengan nilai yang ditentukan.
NotFound()	NotFoundResult Membuat (404 Tidak Ditemukan).
Ok()	OkResult Membuat (200 OK).
Ok<T>(T)	OkObjectResult Membuat (200 OK) dengan nilai yang ditentukan.
Redirect(String)	RedirectResult Membuat (302 Ditemukan) dengan nilai yang ditentukan.
Redirect(Uri)	RedirectResult Membuat (302 Ditemukan) dengan nilai yang ditentukan.
RedirectToRoute(String, Object)	RedirectToRouteResult Membuat (302 Ditemukan) dengan nilai yang ditentukan.
ResponseMessage(HttpResponseMessage)	ResponseMessageResult Membuat dengan respons yang ditentukan.
StatusCode(HttpStatusCode)	StatusCodeResult Membuat dengan kode status yang ditentukan.
Validate<TEntity>(TEntity)	Memvalidasi entitas yang diberikan dan menambahkan kesalahan validasi ke ModelState di bawah awalan kosong.
Validate<TEntity>(TEntity, String)	Memvalidasi entitas yang diberikan dan menambahkan kesalahan validasi ke ModelState.