API

Z PHPEdia.pl
Skocz do: nawigacji, wyszukiwania

ang. Application Programming Interface - interfejs programowania aplikacji, interfejs programu użytkownika. Skrót ten oznacza specyfikację wszystkich funkcji, struktur, interfejsów, itd. pozwalających na wzajemną komunikację między różnymi systemami, aplikacjami lub częściami aplikacji. Programista może użyć ich, aby jeden skrypt mógł korzystać z funkcjonalności udostępnianej przez inny. Przykładem API jest zestaw funkcji standardowo dostępnych w PHP, dzięki którym skrypty mogą np. komunikować się z bazą danych.

Budowanie API

API powinno ukrywać przed użytkownikiem jak najwięcej technicznych szczegółów działania konkretnego kawałka kodu, do których w miarę możliwości programista nie powinien mieć również dostępu. Pozwala to na zmniejszenie liczby możliwych do popełnienia błędów oraz ułatwia zrozumienie działania programów.

Dobre API musi być tworzone z myślą o ułatwieniu tworzenia oprogramowania programiście, gdyż tylko wtedy korzystanie z niego będzie mieć sens. Często od projektu API zależy duża część możliwości, jakie skrypt udostępnia. Jeśli na poziomie projektowania nie przewidzimy pewnych sytuacji, programista nie będzie mógł z nich korzystać, mimo iż z technicznego punktu widzenia skrypt mógłby je obsługiwać. API powinno również służyć użytkownikom aplikacji dzięki zapewnieniu jednolitego działania podobnych elementów w obrębie serwisu WWW.

Dokumentacja

Aby programista mógł skorzystać z API, niezbędne jest jego udokumentowanie, tj. stworzenie dokumentu opisującego znaczenie, działanie i sposób wywołania wszystkich dostępnych funkcji wraz z przykładami ich użycia. Wielu programistów bardzo często bagatelizuje ten element kosztem osób, które będą używać ich produktów oraz na współpracownikach, którzy muszą korzystać z nieopisanego kodu w innych częściach aplikacji, nie wiedząc, co on tak naprawdę robi.