Пишите элегантные API в стиле Restful

задняя часть
Пишите элегантные API в стиле Restful

«Это 14-й день моего участия в ноябрьском испытании обновлений. Подробную информацию об этом событии см.:Вызов последнего обновления 2021 г.".

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

1: Отображение Restful API

   Без дальнейших церемоний, давайте сначала покажем Restful API.

1、// 新增一篇文章
@RequestMapping(value = "/articles",method = RequestMethod.POST)

2、// 删除一篇文章
@RequestMapping(value = "/articles",method = RequestMethod.DELETE)

3、// 删除某一类文章下的一篇文章
@RequestMapping(value = "/types/{id}/articles",method = RequestMethod.DELETE)

4、 // 查询一篇文章
@RequestMapping(value = "/articles/{id}",method = RequestMethod.GET)

5、// 查询某一类文章中的所有文章
@RequestMapping(value = "/types/{id}/articles",method = RequestMethod.GET)

6、// 修改一篇文章(全部属性)
@RequestMapping(value = "/articles/{id}",method = RequestMethod.PUT)

7、// 修改一篇文章(某些属性)
@RequestMapping(value = "/articles/{id}",method = RequestMethod.PATCH)

Второе: происхождение стиля Restful API

Полное название   Rest (Representational State Transfer) — передача представительного состояния, состоящая изRoy Thomas FieldingДоктор философии в 2000 году, он представляет собой новый архитектурный стиль, легкий, кросс-платформенный, кросс-языковой архитектурный дизайн.

  API (интерфейс прикладного программирования): это хорошо известный интерфейс, который представляет собой набор спецификаций интерфейса программирования.Клиент и сервер обмениваются данными через запрос и ответ.

  RestfulAPI: это не новая технология, а стиль дизайна API, основанный на идее архитектуры Rest.

Третье: преимущества стиля Restful API

(1) Преимущества:

  1. ресурсо-ориентированный (существительное)

  2. Знайте, какие ресурсы вам нужны через URL

  3. Знайте, что делать с ресурсами с помощью метода Http (get/post...)

  4. Узнайте результат через код состояния Http

(2) Объяснение преимуществ:

  (1) Знайте, какие ресурсы вам нужны, через URL-адрес: API-интерфейсы, представляющие стиль Restful, могут напрямую видеть, какие ресурсы вам нужны для работы, через URL-адрес, который является семантическим.

(2) API в стиле Restful является ресурсо-ориентированным (имя), то есть в URL-адресе нет соответствующего глагола, а операции с ресурсами выполняются с помощью метода Http (т. е.: пост-добавить, удалить-удалить, поставить-изменить (обычно: предоставить всю информацию о сущности), patch-change (изменить некоторые атрибуты сущности), получить-проверить).

  (3) Узнайте результат через код состояния HTTP: например, обычное значение 200 (успех), 400 (неверный параметр запроса), 500 (ошибка сервера) и т. д.

Четвертое: Примечания к стилю Restful API

  1. При запросе ресурсов следует использовать множественное число, а не единственное, потому что стиль Restful API ориентирован на ресурсы (существительное).

  2. Обязательное добавление заявления о версии API, не публикуйте API без версии, например: api.v1/blogs (открытый и закрытый принцип), закрыть для разработки расширения и модификации, если вам нужно добавить новые функции позже, вы можете напрямую открыть новый интерфейс и добавьте только номер версии.

Пятое: Резюме

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

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

Категории