Поделиться через


ApiController Класс

Определение

Определяет свойства и методы контроллера 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
Наследование
ApiController
Атрибуты
Реализации

Конструкторы

ApiController()

Определяет свойства и методы контроллера API.

Свойства

ActionContext

Возвращает набор ActionContext.

Context

Возвращает контекст HTTP.

ControllerContext

Возвращает или задает класс ControllerContext.

MetadataProvider

Возвращает набор IModelMetadataProvider.

ModelState

Получает состояние модели после привязки модели. ModelState будет пустым до привязки модели.

ObjectValidator

Возвращает или задает класс IObjectModelValidator.

Request

Возвращает или задает сообщение HTTP-запроса.

Url

Возвращает фабрику, используемую для создания URL-адресов для других API.

User

Возвращает или задает текущий субъект, связанный с этим запросом.

Методы

BadRequest()

Создает BadRequestResult (400 Bad Request).

BadRequest(ModelStateDictionary)

InvalidModelStateResult Создает (400 Bad Request) с указанным состоянием модели.

BadRequest(String)

Создает BadRequestErrorMessageResult (400 Bad Request) с указанным сообщением об ошибке.

Conflict()

Создает ConflictResult конфликт (409).

Content<T>(HttpStatusCode, T)

Создает объект NegotiatedContentResult<T> с указанными значениями.

Created(String, Object)

CreatedResult Создает объект (201 Created) с указанными значениями.

Created(Uri, Object)

CreatedResult Создает объект (201 Created) с указанными значениями.

CreatedAtRoute(String, Object, Object)

CreatedAtRouteResult Создает объект (201 Created) с указанными значениями.

Dispose()

Выполняет определяемые приложением задачи, связанные с удалением, высвобождением или сбросом неуправляемых ресурсов.

Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые объектом , и при необходимости освобождает управляемые ресурсы.

InternalServerError()

Создает ( InternalServerErrorResult внутренняя ошибка сервера 500).

InternalServerError(Exception)

Создает ( ExceptionResult внутренняя ошибка сервера 500) с указанным исключением.

Json<T>(T)

JsonResult Создает объект (200 OK) с указанным значением.

Json<T>(T, JsonSerializerSettings)

Создает объект JsonResult (200 OK) с указанными значениями.

Json<T>(T, JsonSerializerSettings, Encoding)

Создает объект JsonResult (200 OK) с указанными значениями.

NotFound()

Создает объект NotFoundResult (404 Not Found).

Ok()

Создает объект OkResult (200 OK).

Ok<T>(T)

Создает объект OkObjectResult (200 OK) с указанными значениями.

Redirect(String)

Создает RedirectResult объект (302 Found) с указанным значением.

Redirect(Uri)

Создает RedirectResult объект (302 Found) с указанным значением.

RedirectToRoute(String, Object)

Создает RedirectToRouteResult объект (302 Found) с указанными значениями.

ResponseMessage(HttpResponseMessage)

Создает объект с указанным ответом ResponseMessageResult .

StatusCode(HttpStatusCode)

Создает объект StatusCodeResult с указанным кодом состояния.

Validate<TEntity>(TEntity)

Проверяет заданную сущность и добавляет ошибки проверки в ModelState под пустым префиксом.

Validate<TEntity>(TEntity, String)

Проверяет заданную сущность и добавляет ошибки проверки в ModelState.

Применяется к