Построение эффективной архитектуры RESTful API

http://interosite.ru/articles/rest-api-design

Построение эффективной архитектуры RESTful API

В одном из недавних проектов мне пришлось делать бекенд для мобильного приложения. Обязательной частью была разработка RESTful  API, которое потенциально могло бы использоваться и разработчиками сторонних приложений. Это означало, что нужно, сделать API максимально удобным в использовании и поддержке.

Прежде чем начать проектировать и реализовывать RESTful-интерфейс, я полез в интернет, чтобы выяснить — пок каким основным принципам строятся эффективные API и каких архитектурных практик лучше придерживаться. В итоге был собран материал, которым я и хочу поделиться в данной статье.

Структура путей ресурсов

По возможности, лучше использовать существительные, а не глаголы.

Идеология REST строится вокруг ресурсов и метода доступа к ним. Поэтому, если нужно, например, предоставить доступ к списку банковских счетов, то использования такого имени ресурса будет не лучшей идеей:

/getAllAccounts

Вместо этого, лучше строить url вокруг имен сущностей предметной области (если нужно, во множественном числе):

/accounts

К такому типу ссылок очень легко привыкнуть, он не перегружен лишней информацией. Достаточно легко понять, без дополнительных пояснений (getAll**), что данный ресурс предоставляет доступ к списку неких счетов. Имена, похожие на названия методов класса, типа getAllAccounts — это скорее из мира RPC и в данном случае только усложняют восприятие и выразительность API.

Если нужен доступ к конкретному объекту, то можно использовать его бизнес-идентификатор:

GET /accounts/123 HTTP/1.1

В данном примере запрашивается счет (account) c идентификатором 123.

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

Нужно отметить, что использовать глаголов в именах ресурсов все же можно (и нужно) в некоторых специальных случаях (см. далее).

Методы HTTP

Как выразить желание, например, добавить новый счет? Наверное, использование имени ресурса  /addNewAccount было бы выходом из ситуации.

Однако, спецификация  REST  предоставляет долее элегантный способ выполнить определенное действие над ресурсом. Спецификация HTTP  содержит понятие методов, которые позволяют для одного и того-же ресурса (пути) указать желаемое действие.

В таблице ниже приводится списко имен методов и действий, которые они подразумевают. Также, приведены примеры доступа к двум видам ресурсов — коллекции и к конкретному объекту.

метод	Действие	/accounts	/accounts/123
GET	Прочитать	Получить список счетов	Получить счет с id=123
POST	Создать	Создать новый счет	Ошибка — ресурс уже создан
PUT	Обновить	Обновить несколько счетов	Обновить счет с id=123
DELETE	Удалить	Удалить все счета	Удалить счет с id=123

Таким образом, можно организовать  управление любыми REST-ресурсами, не загрязняя имена самих ресурсов ненужной информацией.

Ассоциации и дополнительные условия

Часто появляется задача получить коллекцию сущностей, ассоциированных с некоторой заданной сущностью другого типа. Например, нужно получить все транзакции по данному счету. Лучшим, и наиболее понятным способом будет явно указать это в пути ресурса:

/accounts/123/transactions

Имя этого ресурса говорит само за себя — у счета с id=123 получить все его транзакции. Сложно представить более выразительный способ с помощью имен ресурсов описать связь между сущностями.

Иногда есть необходимость построить более сложные правила ассоциации. Например, получить все транзакции для данного счета за опредеренный период времени. Либо, транзакции только определнного типа. В этом случае может появиться желание увеличить вложенность ресурсов, например:

/accounts/123/transactions/debits

Обычно вложенность пути больше 3-х говорит об ошибке проектирования API. наилучшим способом в данном случает, все дополнительные параметры нужно выносить в строку параметров, за ‘?':

/accounts/123/transactions?type=debit&dateFrom=2013-12-25&dateTo=2014-01-29

Параметры  type, dateFrom, dateTo необязательны, поэтому результат запроса может быть настроен очень гибко. Следует специально позаботиться о правильном именовании параметров ресурса. Сравните, например, предыдущий пример, с таким:

/accounts/123/transactions?t=debit&df=2013-12-25&dt=2014-01-29

Чтобы понять, как управлять данным запросом, придется обратиться к документации API, т.к. имена параметров мало что говорят о своих значениях.

Обработка ошибок

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

Возможны два варианта как именно с ответом сервера предоставить описание ошибки — используя стандартные HTTP-коды ответа или возвращая всю информациб только в теле запроса.

В последнем случае всегда возвращается код успешного завершения операции (200), а код и описание ошибки находятся в теле ответа.

GET /baditems HTTP/1.1
200 OK
(...заголовки...)
{
  "error_code": "some_custom_code", "error_description": "Ресурс не найден"
}

Пользователю API придется дополнительно разбираться, как устроено ваше API, чтобы понять, что означаю ваши коды ошибок и откуда из брать.

Лучшим подходом будет использование HTTP-кодов состояния запроса и максимальное их соответствие результату запроса. Поскольку большинство разработчиков уже знают значение стандартных кодов состояний, им будет проще интерпретировать ответ сервера.

Скорее всего, вам не нужно использовать все доступные коды из спецификации HTTP (их около 70-и). Для построение API будет вполне достаточно 3-5 основных кодов и несколько вспомогательных.

Например, основные:

200  — все в порядке

400 — неправильный запрос

500 — внутренняя ошибка сервера

И вспомогательные:

201 — Ресурс создан успешно
304 — Не изменен (не нужно запрашивать снова)
404 – Ресурс не найден
401 — Вы не авторизованны для доступа к данному ресурсу
403 — Доступ запрещен по какой-то причине

Конечно, просто вернуть код ошибки недостаточно. Лучше, вместе с этим, предоставить пользователю как можно более подробную информацию об источнике проблемы. Например:

401

{"devMessage" : "Сообщение для разработчика с подробным описанием проблемы", "usrMessage":"Сообщение для пользователя приложения", "code" : 666, "aditionalInfo": "http://site.com/docs/errors/666"}

Как видите, ответ сервера содержит не только код и описание ошибки, о и ссылку в базу знания о возможной причине возникновения ошибки.

Нужно отметить такую деталь. Некоторые типы клиенты, получив ответ с кодом,  отличным от 200, сразу отображают ошибку конечному пользователя, до того, как клиентский код сможет обработать ее более подходящим образом.

Поэтому, если планируется поддержка различных типов клиентов, то рекомендуется предоставить возможность клиенту отключать HTTP-коды состояний и всегда возвращать код 200. Сделать это можно, например, с помощью параметра вродеalways_success_code=true. Если он задан, то сервер будет всегда возвращать успешный код 200, а код ошибки будет содержаться в теле ответа.

Версии

Если ваше API  со временем будет претерпевать значительные изменения — буду добавляться новые возможности, изменится модель данных, которую обслуживает API — то, скорее всего, потребуется явно указать новые возможности с помощью номера версии. Если единственное клиентское приложение, которое использует API, также, как и код сервера, находится в вашем ведении, то подддрежка версий может не понадобиться — вы просто выпускаете новую версию клиента вместе с обновлением API.

Наоборот, если ваше API  используется в сторонних приложениях, то поддержка версий должна быть включена в архитектуру API  как можно раньше.

О поддержке версий следует подумать с самого начала. Как правило, разумно поддерживать миним одну версию ниже предыдущей, чтобы разработчики клиентских приложения успели мигрировать на последнюю версию API. Для различных типов клиентов предпочтительный периоб обновления версий может значительно отличаться  — от пары месяцев для веб-клиентов, до полугода и более для, скажем, мобильных приложений.

Есть два варианта указать версию — параметром после ‘?’ или с помощью специального заголовка ответа. В любом случае, предпочтительнее задавать версию в качестве первого элемента пути к ресурсу:

/v3/accounts/123

Иногда, правда, это очень трудно сделать, например, если структура ссылок, при развитии проекта, стала достаточно запутанной из-за ошибок проектирования, а о поддержке версий изначально не задумывались. Тогда остаются варианты с заголовком или наименее предпочтительный вариант — указать версию параметром запроса:

/accounts?v=3

Использование заголовка для указании версии может быть вполне оправданным выбором, т.к. это не затрагивает структуру пути к ресурсу (если вас действительно беспокоит строгое соответствие стандарту REST). С этим могут быть связаны некоторые неудобства для, например, разработчика клиентского веб-приложения. Действительно, гораздо проще видеть номер версии сразу в URL-е запроса, чем каждый раз искать его среди заголовков ответа.

Постраничная навигация и частичная выборка данных

У банковского счета может быть достаточно много полей, не все из которых нужны для отображения в интерфейсе пользователя. Например, для списка счетов, может понадобиться только тип счета и его название. Поэтому хорошее API должно поддерживать частичную выборку данных.

Проще всего это сделать с помощью перечисления списка полей через запятую, например:

/accounts?fields=id,type,name

Такой подход снижает издержки в клиентском коде, а также уменьшает интернет-трафик.

Для просмотра больших массивов данных, помимо частичной выборки полей, нужно организовать возможность разбиения на страницы. Устоявшейся и хорошо знакомой многим разработчикам парадигмой являются использование параметров offset (кол-во записей от начала) и limit (максимальное количество возвращаемых записей):

/accounts?offset=40&limit=10

Данный запрос начнет выборку данных, начиная с 40-й записи и вернет не более 10-и записей.

Предоставление сервисов

Иногда API, помимо доступа к неким сущностям предметной области, должно предоставлять некоторые вычислительные сервисы или составные операции, которые не могут быть представлены как действия над отдельными объектами.

Тогда не остается ничего, кроме как забыть про первый совет (существительные, а не глаголы), и использовать названия действий в путях.

Например, API может предоставлять сервис конвертера валют:

GET /convert?from=EUR&to=CNY&amount=100 HTTP/1.1

Тут используется имя операции (convert), которая принимает несколько именованных параметров (from, to и amount).

Другой типичный пример — синхронизация данных на мобильном устройстве с данными в облачном сервисе. Эта операция должны быть атомарной, и, следовательно, иметь одну точку входа, которую лучше всего описать опять именем действия:

POST /synchronize HTTP/1.1
Content-Type: application/xml

<transactions>
  <transaction>
   <accountId>123</accountId>
   <date>2013-12-12 17:15</date>
   <sum>4500</sum> 
  <transaction>
(...)
</transactions>

Формат данных

Желательно, чтобы запрос к одному и тому-же ресурсу поддерживал ответ в различных форматах (json, xml, csv и т.д.)

Классическим способом для клиента указать желаемый формат ответа является HTTP-заголовок Accept:

GET /accounts HTTP/1.1
Accept: application/xml

В качестве значение заголовка указывается один из определенных стандартом mime-типов.

Однако, более выразительным способом может быть применение расширений, аналогичных расширениям файлов в операционных системах:

/accounts.json

или

/accounts.xml

Практически для любого mime-типа существует расширение файла, хорошо знакомое не только программистам, но и рядовым пользователям. Это может в несколько раз увеличить читаемость и выразительность API.

Аутентификация

Ограничение доступа к ресурсам является достаточно большой темой, которая заслуживает отдельной статьи, которая, я думаю скоро появится в этом блоге.

В качестве общей рекомендации можно посоветовать не использовать доморощенной схемы аутентификации. Вместо этого применять известные и хорошо протестированные схемы, такие как:

• Дайджест-аутентификация
• OAuth1.0a
• OAuth2

Для практически всех языков программирования существуют встроенные или сторонние реализации этих протоколов, поэтому практически всегда имеет смысл использовать именно их, а не свое, потенциально ненадежное решение.

Заключение

В заключение стоит отметить, что для любого публичного API может быть очень хороше опцией наличие SDK для популярных языков программирования (Java, Python, Ruby, PHP). Это может значительно увеличить лояльность сторонних разработчиков, тем самым увеличивая потенциальную аудиторию вашего сервиса.

IIS 7: компрессия JSON ответа

http://habrahabr.ru/post/180769/

IIS 7: компрессия JSON ответа tutorial

ASP*, .NET*

Несколько дней назад мой знакомый обратил внимание, что его большие JSON ответы (порядка 0,5-1 мегабайт) не паковались. Рабочая связка Windows 2008 R2 + IIS 7.5 + ASP.NET MVC 4. Проблема обозначена, начался поиск решения. Чтобы воспроизвести наши действия, для статьи я написал отдельное приложение.

Метод действия

public ActionResult Index()
{
    if (Request.IsAjaxRequest())
    {
        return Json(new {/*большой объем данных*/}, JsonRequestBehavior.AllowGet);
    }
    return View();
}

Представление

<script src="http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.9.0.js"></script>

<script type="text/javascript">
    jQuery(function ($) {
        $.ajax({
            url: '@Url.Action("Index")'
        });
    })
</script>

Первое, что было проверено, HTTP заголовки



Со скриншота видно, что идет ajax запрос X-Requested-With: XMLHttpRequest и браузер сообщает, что он понимает gzip или deflate заголовком Accept-Encoding: gzip, deflate, на что сервер отвечает json-ом Content-Type: application/json, но без сжатия, так как отсутствует заголовок Content-Encoding.

Далее пошла проверка на установленные модули веб сервера Administrative Tools -> Server Manager -> Roles -> IIS



Static/Dynamic Content Comprassion установлены. (Хочу обратить внимание, для Windows 7 установка осуществляется через добавление/удаление компонентов).
Далее проверяем, включена ли компрессия для приложения на IIS.





Если нет, то ставим галочки и применяем изменения. Разрешить компрессию также возможно через web.config

<system.webServer>
  <urlCompression doStaticCompression="true" doDynamicCompression="true" />
</system.webServer>

либо Configuration Editor -> system.webServer -> urlCompression







Кажется, уже все в порядке, но IIS как не отдавал Content-Encoding в заголовке ответа, так и не отдает.

В ход пошел

<system.webServer>
    <httpCompression>
      <dynamicTypes>
        <add mimeType="application/json" enabled="true" />
        <add mimeType="application/json; charset=utf-8" enabled="true" />        
      </dynamicTypes>
    </httpCompression>
</system.webServer>

и, ура, победа, мы получаем долгожданный Content-Encoding: gzip. Но есть одно очень большое НО. httpCompression секцию можно определить только в applicationhost.config. А это значит, что либо вы администратор IIS, либо такой вариант вам не подходит (если, конечно, вы не убедите вашего хостера в обратном).

Предположим, что найденный вариант вам не подходит, а сжимать ответ вам все-таки надо. Что мы имеем по умолчанию в настройках динамической компрессии.



Компрессия будет распространяться, к примеру, на text/javascript. Конечно, это больше похоже на хак, но это лучше, чем ничего.

Меняем наш метод действия на

public ActionResult Index()
{
    if (Request.IsAjaxRequest())
    {
        return new JsonResult()
        {
            ContentType = "text/javascript",
            ContentEncoding = Encoding.UTF8,
            JsonRequestBehavior = JsonRequestBehavior.AllowGet,
            Data = new {/*большой объем данных*/}
        };
    }
    return View();
}

и при ответе используя функцию $.ajax, тут же получаем ошибку парсинга данных. Иными словами, теперь мы должны использовать либо $.getJSON, либо явно указывать, что мы ожидаем json.

Представление

<script src="http://ajax.aspnetcdn.com/ajax/jquery/jquery-1.9.0.js"></script>

<script type="text/javascript">
    jQuery(function ($) {
        $.ajax({
            url: '@Url.Action("Index")',
            dataType: 'json',
        });
    })
</script>

И третье решение, которое появилось, но под те задачи не подходило (это не значит, что оно не достойно внимания) – паковать самим.

Привожу пример со стэка, с которым я полностью согласен

public class CompressAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {

        var encodingsAccepted = filterContext.HttpContext.Request.Headers["Accept-Encoding"];
        if (string.IsNullOrEmpty(encodingsAccepted)) return;

        encodingsAccepted = encodingsAccepted.ToLowerInvariant();
        var response = filterContext.HttpContext.Response;

        if (encodingsAccepted.Contains("deflate"))
        {
            response.AppendHeader("Content-encoding", "deflate");
            response.Filter = new DeflateStream(response.Filter, CompressionMode.Compress);
        }
        else if (encodingsAccepted.Contains("gzip"))
        {
            response.AppendHeader("Content-encoding", "gzip");
            response.Filter = new GZipStream(response.Filter, CompressionMode.Compress);
        }
    }
}

Степень сжатия данных

Пока игрались с выше сказанным, была замечена еще одна интересная вещь, сжатый контент в Fiddler распаковывался и самим же фидлером опять перепаковывался, сжатия у фидлера на глаз было на ~10-20% меньше байт. Как найти настройки степени сжатия для IIS, ума не приложу. Не считая третьего варианта, в котором можно использовать параметр конструкторов CompressionLevel. Может, кто из вас подскажет? Этот момент для себя считаю важным, так как в зависимости от проекта иногда важен объем передаваемого трафика, а иногда, наоборот, процессорное время.

Буду рад услышать еще варианты решения проблемы, какими бы безумными идеи на первый взгляд не казались.

Пример авторизации, спецификации API на примере Яндекса

https://tech.yandex.ru/market/partner/doc/dg/concepts/sandbox-docpage/

HTTP Status Codes in API

http://www.restapitutorial.com/httpstatuscodes.html

1xx Informational[edit]

Request received, continuing process.

This class of status code indicates a provisional response, consisting only of the Status-Line and optional headers, and is terminated by an empty line. Since HTTP/1.0 did not define any 1xx status codes, servers must not^{[note 1]} send a 1xx response to an HTTP/1.0 client except under experimental conditions.

100 Continue

This means that the server has received the request headers, and that the client should proceed to send the request body (in the case of a request for which a body needs to be sent; for example, a POST request). If the request body is large, sending it to a server when a request has already been rejected based upon inappropriate headers is inefficient. To have a server check if the request could be accepted based on the request's headers alone, a client must send Expect: 100-continue as a header in its initial request and check if a 100 Continue status code is received in response before continuing (or receive 417 Expectation Failed and not continue).

101 Switching Protocols

This means the requester has asked the server to switch protocols and the server is acknowledging that it will do so.

102 Processing (WebDAV; RFC 2518)

As a WebDAV request may contain many sub-requests involving file operations, it may take a long time to complete the request. This code indicates that the server has received and is processing the request, but no response is available yet.^[3] This prevents the client from timing out and assuming the request was lost.

2xx Success[edit]

This class of status codes indicates the action requested by the client was received, understood, accepted and processed successfully.

200 OK

Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action.

201 Created

The request has been fulfilled and resulted in a new resource being created.

202 Accepted

The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.

203 Non-Authoritative Information (since HTTP/1.1)

The server successfully processed the request, but is returning information that may be from another source.

204 No Content

The server successfully processed the request, but is not returning any content. Usually used as a response to a successful delete request.

205 Reset Content

The server successfully processed the request, but is not returning any content. Unlike a 204 response, this response requires that the requester reset the document view.

206 Partial Content (RFC 7233)

The server is delivering only part of the resource (byte serving) due to a range header sent by the client. The range header is used by tools like wget to enable resuming of interrupted downloads, or split a download into multiple simultaneous streams.

207 Multi-Status (WebDAV; RFC 4918)

The message body that follows is an XML message and can contain a number of separate response codes, depending on how many sub-requests were made.^[4]

208 Already Reported (WebDAV; RFC 5842)

The members of a DAV binding have already been enumerated in a previous reply to this request, and are not being included again.

226 IM Used (RFC 3229)

The server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.^[5]

3xx Redirection[edit]

This class of status code indicates the client must take additional action to complete the request. Many of these status codes are used in URL redirection.

A user agent may carry out the additional action with no user interaction only if the method used in the second request is GET or HEAD. A user agent should not automatically redirect a request more than five times, since such redirections usually indicate an infinite loop.

300 Multiple Choices

Indicates multiple options for the resource that the client may follow. It, for instance, could be used to present different format options for video, list files with different extensions, or word sense disambiguation.

301 Moved Permanently

This and all future requests should be directed to the given URI.

302 Found

This is an example of industry practice contradicting the standard. The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"),^[6] but popular browsers implemented 302 with the functionality of a 303 See Other. Therefore, HTTP/1.1 added status codes 303 and 307 to distinguish between the two behaviours.^[7] However, some Web applications and frameworks use the 302 status code as if it were the 303.^[8]

303 See Other (since HTTP/1.1)

The response to the request can be found under another URI using a GET method. When received in response to a POST (or PUT/DELETE), it should be assumed that the server has received the data and the redirect should be issued with a separate GET message.

304 Not Modified (RFC 7232)

Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-None-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.

305 Use Proxy (since HTTP/1.1)

The requested resource is only available through a proxy, whose address is provided in the response. Many HTTP clients (such as Mozilla^[9] and Internet Explorer) do not correctly handle responses with this status code, primarily for security reasons.^[10]

306 Switch Proxy

No longer used. Originally meant "Subsequent requests should use the specified proxy."^[11]

307 Temporary Redirect (since HTTP/1.1)

In this case, the request should be repeated with another URI; however, future requests should still use the original URI. In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request. For instance, a POST request should be repeated using another POST request.^[12]

308 Permanent Redirect (RFC 7538)

The request, and all future requests should be repeated using another URI. 307 and 308 (as proposed) parallel the behaviours of 302 and 301, but do not allow the HTTP method to change. So, for example, submitting a form to a permanently redirected resource may continue smoothly.^[13]

308 Resume Incomplete (Google)

This code is used in the Resumable HTTP Requests Proposal to resume aborted PUT or POST requests.^[14]

4xx Client Error[edit]

404 error on German Wikipedia

The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server should include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition. These status codes are applicable to any request method. User agents should display any included entity to the user.

400 Bad Request

The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).^[15]

401 Unauthorized (RFC 7235)

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. See Basic access authentication and Digest access authentication.

402 Payment Required

Reserved for future use. The original intention was that this code might be used as part of some form of digital cash or micropayment scheme, but that has not happened, and this code is not usually used. YouTube uses this status if a particular IP address has made excessive requests, and requires the person to enter aCAPTCHA.^{[citation needed]}

403 Forbidden

The request was a valid request, but the server is refusing to respond to it. Unlike a 401 Unauthorized response, authenticating will make no difference.

404 Not Found

The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.

405 Method Not Allowed

A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.

406 Not Acceptable

The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.

407 Proxy Authentication Required (RFC 7235)

The client must first authenticate itself with the proxy.

408 Request Timeout

The server timed out waiting for the request. According to HTTP specifications: "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time."

409 Conflict

Indicates that the request could not be processed because of conflict in the request, such as an edit conflict in the case of multiple updates.

410 Gone

Indicates that the resource requested is no longer available and will not be available again. This should be used when a resource has been intentionally removed and the resource should be purged. Upon receiving a 410 status code, the client should not request the resource again in the future. Clients such as search engines should remove the resource from their indices.^[16] Most use cases do not require clients and search engines to purge the resource, and a "404 Not Found" may be used instead.

411 Length Required

The request did not specify the length of its content, which is required by the requested resource.

412 Precondition Failed (RFC 7232)

The server does not meet one of the preconditions that the requester put on the request.

413 Payload Too Large (RFC 7231)

The request is larger than the server is willing or able to process. Called "Request Entity Too Large " previously.

414 Request-URI Too Long

The URI provided was too long for the server to process. Often the result of too much data being encoded as a query-string of a GET request, in which case it should be converted to a POST request.

415 Unsupported Media Type

The request entity has a media type which the server or resource does not support. For example, the client uploads an image as image/svg+xml, but the server requires that images use a different format.

416 Requested Range Not Satisfiable (RFC 7233)

The client has asked for a portion of the file (byte serving), but the server cannot supply that portion. For example, if the client asked for a part of the file that lies beyond the end of the file.

417 Expectation Failed

The server cannot meet the requirements of the Expect request-header field.

418 I'm a teapot (RFC 2324)

This code was defined in 1998 as one of the traditional IETF April Fools' jokes, in RFC 2324, Hyper Text Coffee Pot Control Protocol, and is not expected to be implemented by actual HTTP servers. The RFC specifies this code should be returned by tea pots requested to brew coffee.

419 Authentication Timeout (not in RFC 2616)

Not a part of the HTTP standard, 419 Authentication Timeout denotes that previously valid authentication has expired. It is used as an alternative to 401 Unauthorized in order to differentiate from otherwise authenticated clients being denied access to specific server resources.^{[citation needed]}

420 Method Failure (Spring Framework)

Not part of the HTTP standard, but defined by Spring in the HttpStatus class to be used when a method failed. This status code is deprecated by Spring.

420 Enhance Your Calm (Twitter)

Not part of the HTTP standard, but returned by version 1 of the Twitter Search and Trends API when the client is being rate limited.^[17] Other services may wish to implement the 429 Too Many Requests response code instead.

421 Misdirected Request (HTTP/2)

The request was directed at a server that is not able to produce a response (for example because a connection reuse).^[18]

422 Unprocessable Entity (WebDAV; RFC 4918)

The request was well-formed but was unable to be followed due to semantic errors.^[4]

423 Locked (WebDAV; RFC 4918)

The resource that is being accessed is locked.^[4]

424 Failed Dependency (WebDAV; RFC 4918)

The request failed due to failure of a previous request (e.g., a PROPPATCH).^[4]

426 Upgrade Required

The client should switch to a different protocol such as TLS/1.0, given in the Upgrade header field.

428 Precondition Required (RFC 6585)

The origin server requires the request to be conditional. Intended to prevent "the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict."^[19]

429 Too Many Requests (RFC 6585)

The user has sent too many requests in a given amount of time. Intended for use with rate limiting schemes.^[19]

431 Request Header Fields Too Large (RFC 6585)

The server is unwilling to process the request because either an individual header field, or all the header fields collectively, are too large.^[19]

440 Login Timeout (Microsoft)

A Microsoft extension. Indicates that your session has expired.^[20]

444 No Response (Nginx)

Used in Nginx logs to indicate that the server has returned no information to the client and closed the connection (useful as a deterrent for malware).

449 Retry With (Microsoft)

A Microsoft extension. The request should be retried after performing the appropriate action.^[21]

450 Blocked by Windows Parental Controls (Microsoft)

A Microsoft extension. This error is given when Windows Parental Controls are turned on and are blocking access to the given webpage.^[22]

451 Unavailable For Legal Reasons (Internet draft)

Defined in the internet draft "A New HTTP Status Code for Legally-restricted Resources".^[23] Intended to be used when resource access is denied for legal reasons, e.g. censorship or government-mandated blocked access. A reference to the 1953 dystopian novel Fahrenheit 451, where books are outlawed.^[24]

451 Redirect (Microsoft)

Used in Exchange ActiveSync if there either is a more efficient server to use or the server cannot access the users' mailbox.^[25]

The client is supposed to re-run the HTTP Autodiscovery protocol to find a better suited server.^[26]

494 Request Header Too Large (Nginx)

Nginx internal code similar to 431 but it was introduced earlier in version 0.9.4 (on January 21, 2011).^{[27][original research?]}

495 Cert Error (Nginx)

Nginx internal code used when SSL client certificate error occurred to distinguish it from 4XX in a log and an error page redirection.

496 No Cert (Nginx)

Nginx internal code used when client didn't provide certificate to distinguish it from 4XX in a log and an error page redirection.

497 HTTP to HTTPS (Nginx)

Nginx internal code used for the plain HTTP requests that are sent to HTTPS port to distinguish it from 4XX in a log and an error page redirection.

498 Token expired/invalid (Esri)

Returned by ArcGIS for Server. A code of 498 indicates an expired or otherwise invalid token.^[28]

499 Client Closed Request (Nginx)

Used in Nginx logs to indicate when the connection has been closed by client while the server is still processing its request, making server unable to send a status code back.^[29]

499 Token required (Esri)

Returned by ArcGIS for Server. A code of 499 indicates that a token is required (if no token was submitted).^[28]

5xx Server Error[edit]

The server failed to fulfil an apparently valid request.

Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has encountered an error or is otherwise incapable of performing the request. Except when responding to a HEAD request, the server should include an entity containing an explanation of the error situation, and indicate whether it is a temporary or permanent condition. Likewise, user agents should display any included entity to the user. These response codes are applicable to any request method.

500 Internal Server Error

A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.

501 Not Implemented

The server either does not recognize the request method, or it lacks the ability to fulfill the request. Usually this implies future availability (e.g., a new feature of a web-service API).

502 Bad Gateway

The server was acting as a gateway or proxy and received an invalid response from the upstream server.

503 Service Unavailable

The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a temporary state.

504 Gateway Timeout

The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.

505 HTTP Version Not Supported

The server does not support the HTTP protocol version used in the request.

506 Variant Also Negotiates (RFC 2295)

Transparent content negotiation for the request results in a circular reference.^[30]

507 Insufficient Storage (WebDAV; RFC 4918)

The server is unable to store the representation needed to complete the request.^[4]

508 Loop Detected (WebDAV; RFC 5842)

The server detected an infinite loop while processing the request (sent in lieu of 208 Already Reported).

509 Bandwidth Limit Exceeded (Apache bw/limited extension)^[31]

This status code is not specified in any RFCs. Its use is unknown.

510 Not Extended (RFC 2774)

Further extensions to the request are required for the server to fulfil it.^[32]

511 Network Authentication Required (RFC 6585)

The client needs to authenticate to gain network access. Intended for use by intercepting proxies used to control access to the network (e.g., "captive portals" used to require agreement to Terms of Service before granting full Internet access via a Wi-Fi hotspot).^[19]

520 Unknown Error

This status code is not specified in any RFC and is returned by certain services, for instance Microsoft Azure and CloudFlare servers: "The 520 error is essentially a “catch-all” response for when the origin server returns something unexpected or something that is not tolerated/interpreted (protocol violation or empty response)."^[33]

598 Network read timeout error (Unknown)

This status code is not specified in any RFCs, but is used by Microsoft HTTP proxies to signal a network read timeout behind the proxy to a client in front of the proxy.^{[citation needed]}

599 Network connect timeout error (Unknown)

This status code is not specified in any RFCs, but is used by Microsoft HTTP proxies to signal a network connect timeout behind the proxy to a client in front of the proxy.^{[citation needed]}

 "Top 10" HTTP Status Code. More REST service-specific information is contained in the entry.