Крайната точка на 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.