Является тем API REST действительно RPC? Roy Fielding, кажется, думает так

Ваша интерпретация мне кажется правильной. Я действительно верю, что ограничения Филдинга можно применить на практике.

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

Совершенно верно. Кроме того, я хотел бы отметить, что шаблоны URI отлично подходят для приложения RESTful, если они взяты из документов, полученных с сервера (OpenSearch является подходящим примером). Для шаблонов URI вы документируете, где они используются и каковы ожидаемые заполнители в шаблоне, но не сами шаблоны. Слегка вопреки тому, что сказал Ванфриден, это не исключение.

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

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

Мы также включаем ненормативную (информативную) документацию, к которой прилагается отказ от ответственности, чтобы не читать слишком много в URI, упомянутых в документе, который дает примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

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

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

Мы также включаем ненормативные (информативная) документация, к которой прилагается отказ от ответственности, чтобы не зачитывать слишком много URI, упомянутых в документе, в котором приведены примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

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

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

Мы также включаем ненормативные (информативная) документация, к которой прилагается отказ от ответственности, чтобы не зачитывать слишком много URI, упомянутых в документе, в котором приведены примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

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

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

Мы также включаем ненормативную (информативную) документацию, которая прилагается это отказ от ответственности не читать слишком много в URI, упомянутых в документе, который дает примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

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

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

Мы также включаем ненормативную (информативную) документацию, которая прилагается это отказ от ответственности не читать слишком много в URI, упомянутых в документе, который дает примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

с точки зрения и пропускной способности сервера.

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

Мы также включаем ненормативную (информативную) документацию, к которой прилагается отказ от ответственности, чтобы не читать слишком много в URI, упомянутых в документе, который дает примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

с точки зрения и пропускной способности сервера.

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

Мы также включаем ненормативную (информативную) документацию, к которой прилагается отказ от ответственности, чтобы не читать слишком много в URI, упомянутых в документе, который дает примеры типичных взаимодействий клиент-сервер. Это конкретизирует довольно абстрактную нормативную документацию.

и на какие ресурсы указывают URI в этих представлениях.

Мы также включаем ненормативную (информативную) документацию, к которой прилагается отказ от ответственности, чтобы не читать слишком много в URI, упомянутых в документе, в котором приводятся примеры типичные клиент-серверные взаимодействия. Это конкретизирует довольно абстрактную нормативную документацию.

и на какие ресурсы указывают URI в этих представлениях.

Мы также включаем ненормативную (информативную) документацию, к которой прилагается отказ от ответственности, чтобы не читать слишком много в URI, упомянутых в документе, в котором приводятся примеры типичные клиент-серверные взаимодействия. Это конкретизирует довольно абстрактную нормативную документацию.

Единственное исключение из инструкций по созданию URI - это то, что разрешено отправлять шаблон URI в гипертекстовом ответе с полями, которые автоматически подставляются клиентом, используя другие поля в гипертексте. Это не Обычно это приводит к значительной экономии пропускной способности, поскольку сжатие gzip достаточно хорошо обрабатывает повторяющиеся части URI, чтобы не беспокоиться об этом.

Некоторые полезные обсуждения REST и связанных с ним HATEOAS:

Преимущества (также) использования HATEOAS в API RESTFul

Как ПОЛУЧИТЬ чашку кофе

For those interested, I found a detailed example of HATEOAS in practice in the Sun Cloud API.

Большинство людей ошибаются в том, что (по крайней мере, я думаю) в мире REST вы не документируете свой «интерфейс отдыха», то, что вы документируете, является типом мультимедиа. , независимо от вашего сервера или службы.