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

За последние несколько лет мы стали свидетелями RESTful веб-сервисов, которые стали популярными по ряду причин. Вот 10 вещей, которые вы должны сделать, чтобы ваши RESTful веб-сервисы были как можно лучше и легче для других разработчиков.

  1. 1

    Не ищите официальные «стандарты сервисов REST»

    REST веб-сервисы это концепция, а не стандартизированное понятие. Не существует требований для веб-сервисов REST, работайте любым особым образом. Хотя …

  2. 2

    Придерживайтесь стандартов так или иначе

    … Вашим REST веб-сервисах следует придерживаться, по крайней мере, хотя бы некоторых стандартов! Например, есть OAuth для авторизации, JSON и XML для передачи данных, HTTP для транспортировки, и контроля и URI стандарт. Если хотите получить более полный пакет, OData доступен в виде основных пунктов. Просто потому, что никто не говорит, что «остальные должны придерживаться этих стандартов» не означает, что вы должны сделать свой собственный.

  3. 3

    Убедитесь, что документация безупречна

    С SOAP, есть такое определение веб-служб (WSDL) системы, что делает его довольно легким для работы с сервисом, если у вас есть инструмент для автоматической генерации кода на основе WSDL. Но с REST, сервисы менее строго определены, и они зависят от так называемой правильной работы. Это означает, что сервисная документация является критической. Убедитесь в том, что если вы создаете веб-службы REST, документация на 100% правильна.

  4. 4

    Обеспечьте JSON на выходе

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

  5. 5

    Не забывайте XML

    Говоря о исходящей инфе, XML все еще так же важна, как это было всегда. Почему поддерживается и XML и JSON? Потому что не каждая система может работать с JSON, но если система может сделать вызов веб-службы, он должен обеспечить обработку XML. Есть груды устаревших систем, например, работающих с XML, но не JSON, но не все разработчики хотят, чтобы смешивали и сопоставляли JSON и XML. Убедитесь, что ваш сервис поддерживает оба формата. «Accepts» в заголовке запроса HTTP является хорошим способом сделать это вместо параметров или разных URL-адресов службы.

  6. 6

    Понимание терминологии

    Одним из ключевых понятий в сфере REST веб-сервисов является то, что функциональность в значительной степени определяется протоколом HTTP. И самая основная часть HTTP это действия, такие как GET и POST. В то время как основные функционалы хорошо понимаются, некоторые идеи, например с помощью PATCH обновить только определенные атрибуты интерфейса, а не весь объект в целом невозможно.

  7. 7

    Понимание важности URI маршрутизации

    RESTful веб-сервисы зависят в значительной степени от URI, чтобы решить, что делать. Например, в «GET» запросе URI путь обычно содержит значение первичного ключа (или другого идентификатора) интерфейса для извлечения. Например, «http://www.example.com/service/entityname/76» будет получать объект с названием «EntityName» и значение первичного ключа берется из 76. С REST веб-услугой URI это не просто средство доступа к службе, но и способ управления и указания ваших потребностей.

  8. 8

    Не делайте изменения без службы управления версиями

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

  9. 9

    Оставайтесь на связи с пользователями

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

  10. 10

    Предоставляйте примеры кода

    Одна из лучших вещей, которые вы можете сделать, это предоставить примеры кода для разработчиков. Убедитесь, что есть примеры для всех основных языков: Java, NET, JavaScript, Ruby, Python. Если у вас есть возможность нанять консультанта, чтобы написать этот код, то он является абсолютно необходимым для принятия вашего сервиса. Убедитесь, что вы лицензировали пример кода таким образом, что это позволит вашим клиентам использовать его без каких-либо последствий.

Write A Comment