Создание и тестирование API стало проще с почтальоном

Спасибо Джеффу Смиту за любезную помощь в рецензировании этой статьи.

Актуальные сообщения на SitePoint сегодня:

• Что такое HTTP / 2?
• Приручите непослушные таблицы стилей с этими тремя методологиями CSS
• Ваш регулярный контрольный список обслуживания WordPress
• Хостинг на общих серверах: плюсы и минусы
• Почему каждый сайт нуждается в HTTPS

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

Если вы посмотрите в Интернете, большое количество сервисов используют API. Все с социальным логином использует API; мобильное приложение сайта электронной коммерции использует API; даже реклама, которую вы видите в Интернете, использует API!

Создавая API для вашего сервиса, вы позволяете сторонним разработчикам создавать приложения на основе вашего сервиса. Например, социальная газета Frrole использует API Twitter для генерации контекстной информации, анализируя большой объем твитов.

Предполагая, что вы оценили все плюсы и минусы создания API , давайте кратко поговорим о процессе создания и тестирования API.

Создание API

Хотя существует множество способов создания API, веб-API создается с использованием инфраструктуры REST ( Re Presenalal S tate Transfer). Платформа REST устанавливает набор рекомендаций, которым необходимо следовать при создании API. С большим количеством API, создаваемых ежедневно, он служит стандартом для веб-API.

Четырьмя наиболее распространенными действиями, выполняемыми через API, являются просмотр , создание , редактирование и удаление объектов. Среда REST отображает четыре HTTP-глагола на эти действия: GETPOSTPUTDELETE В этот список было добавлено много глаголов, таких как PURGEPATCH Эта статья о передовых практиках прагматичного API RESTful , написанная Vinay Sahni, основателем Enchant.com, может оказаться полезной для начинающего разработчика.

В настоящее время существует множество платформ, которые предоставляют оболочки для основных уровней HTTP, что облегчает вашу жизнь разработчика. Все, что вам нужно сделать, это вызвать необходимые команды или функции и сосредоточиться на функциональности. Популярные примеры включают Slim и Toro , две основанные на PHP микро-фреймворки, которые помогают вам быстро создавать REST API.

Тестирование API через CLI

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

Использование API включает запрос к требуемому ресурсу (обычно URL) с использованием одного из глаголов (или методов). Возможно, вам придется добавить заголовки в зависимости от требований используемого вами API. Один из способов запросить такой ресурс — через командную строку.

В этом посте мы сосредоточимся на четырех частях вызова API — URL, HTTP-глагол, заголовки и параметры. Мы будем использовать библиотеку cURL для отправки запросов к ресурсам API через CLI. cURL — это инструмент командной строки, который помогает в передаче данных с синтаксисом URL — поддержка FTP, FTPS, HTTP, HTTPS.

Давайте посмотрим на следующую команду:

 curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'

 {"message":"success","id":"4"}

 GET /me/

 GET /me/feed/

 GET /post-id/

 POST /post-id/likes/

 DELETE /post-id/likes/

 POST /me/feed/
POST /user-id/feed/
POST /page-id/feed/
POST /event-id/feed/
POST /group-id/feed/

 POST /post-id/

 DELETE /post-id/