Конечная точка API — это точка соединения между двумя программами. API имеют конечные точки для каждого ресурса. Конечные точки указывают точное расположение ресурса на сервере.
Когда клиентское приложение запрашивает информацию с сервера, оно проходит через API. Который затем получает доступ к запросу и обрабатывает ответ от сервера. Затем API передает запрошенную информацию из конечной точки в приложение.
Ваш API эффективен, если он может эффективно взаимодействовать через свои конечные точки. Это облегчает пользователям доступ к ресурсам, улучшая пользовательский опыт.
Как работает конечная точка API?
Интегрированные системы взаимодействуют через API. Одна система отправляет запрос к API, используя такой формат, как SOAP или REST. Сервер получает запросы и передает ответ обратно в API. Расположение запрошенного ресурса является конечной точкой.
Прежде чем конечная точка обработает запрос, клиент должен предоставить URL-адрес, заголовки и тело. Заголовки содержат метаданные о запросе и данные о теле сообщения, отправляемые на сервер. Сервер также может подключаться к базе данных, которая Методы API может получить доступ.
Конечные точки API обычно работают с методами HTTP, такими как GET, DELETE, PATCH или POST. Методы определяют, как использовать конечную точку. Когда клиент отправляет запрос, ему необходимо сформулировать его, включив метод запроса, а также URL-адрес, например:
ПОЛУЧАТЬ https://example.com/books/authorsИменование сложно, будь то конечные точки API, сетевые аппаратные устройстваили функции и переменные. Вы должны узнать о некоторых передовых методах, которые вы можете использовать, чтобы убедиться, что ваши конечные точки API являются активом.
1. Используйте косую черту
Всегда используйте косую черту для разделения ресурсов URI. Косая черта также помогает показать иерархию ресурсов. Ниже приведен пример:
https://example.com/books/authors2. Используйте существительные, а не глаголы
Вы должны использовать только существительные для названия ресурса. Существительные описывают, для чего предназначен ресурс, в отличие от глагола, описывающего, что делает ресурс. Вот пример хорошего и плохого способа именования конечных точек API.
Хорошее название:
https://example.com/api/getBooksПлохое название:
http://example.com/api/books3. Используйте существительные во множественном числе, а не в единственном числе
Вы всегда должны называть конечные точки API существительными во множественном числе. Это указывает пользователю, что на сервере имеется более одного ресурса. Использование существительного в единственном числе может ввести пользователя в заблуждение, заставив его думать, что существует только один ресурс.
Хорошее название:
https://example.com/api/book/3Плохое название:
http://example.com/api/books/34. Используйте строчные буквы
Все URL-адреса следует вводить строчными буквами. Сюда входят URL-адреса конечных точек API. Вот пример:
Хорошее название:
http://example.com/api/Books/3Плохое название:
http://example.com/api/books/35. Используйте дефисы для разделения слов
Используйте дефисы для разделения объединенных слов. Дефисы делают фразы более читаемыми, чем верблюжий регистр или символы подчеркивания. Они также лучше для целей SEO.
Хорошее название:
https://example.com/api/books/33/front_coverПлохое название:
https://example.com/api/books/33/front-cover6. Не добавляйте расширения файлов
Вам не нужно добавлять расширение файла к вашим конечным точкам API. Хотя это не влияет на вывод, расширение затрудняет чтение ресурса. Это также делает ресурс менее гибким, ломая его, если расширение изменится в будущем.
Хорошее название:
https://example.com/api/books.xmlПлохое название:
https://example.com/api/books7. Включить управление версиями
Вы всегда должны называть свои конечные точки API в соответствии с версией. Это важно, если вы вносите серьезные изменения в API. Это помогает различать две или более версий API, из которых исходит ресурс. Вы можете указать версию в начале конечной точки.
Например:
https://example.com/api/v3/booksЗачем учитывать лучшие практики API?
API стали основой современного программирования. Они улучшают совместную работу, поощряют инновации и повышают безопасность приложений.
Независимо от того, используете ли вы новые инструменты или управляете существующими, API упрощают процесс. Поэтому очень важно иметь конечные точки, которые улучшают взаимодействие с пользователем. Именование и структура ваших конечных точек API определяют производительность вашего API.
Убедитесь, что вы используете лучшие практики для создания эффективных конечных точек API.
