Jak podejście API-first kształtuje przyszłość Zonos

Czym jest podejście API-first? 

Podejście API-first zdecydowanie kontrastuje z podejściem code-first, gdzie zespół zaczyna od zaprojektowania funkcjonalności aplikacji, napisania kodu, a następnie dodania interfejsów API na końcu procesu.

W Zonos budowanie oprogramowania przy użyciu podejścia API-first oznacza projektowanie rozwiązań wokół interfejsu API, zamiast kodowania aplikacji i dodawania interfejsu API później. Oznacza to, że nasze interfejsy API są najważniejsze i same w sobie są produktami; projektujemy je z intensywnym skupieniem na potrzebach klientów i wyraźnie dokumentujemy i architekturujemy je przed napisaniem jakiegokolwiek kodu.

Korzyści podejścia API-first 

Podejście API-first pomaga w ustanowieniu następującej mentalności:

• Rozumiemy, że nasze interfejsy API są podstawowym interfejsem dla naszych klientów, dlatego postrzegamy je jako nasze publiczne produkty.
• Dokumentowanie przed napisaniem kodu daje nam możliwość rozumowania, dyskutowania, doskonalenia i komunikowania naszych celów z naszymi zespołami i interesariuszami w celu utworzenia lepszego produktu końcowego.
• Skupiając się na potrzebach naszych klientów, rozumiemy, jak najlepiej projektować interfejsy API spełniające te potrzeby.

Ta mentalność stawia nasze interfejsy API i klientów na pierwszym miejscu i jest krytyczna dla ustanowienia fundacji, gdzie każdy w Zonos jest odpowiedzialny za sukces klientów.

Zespoły deweloperskie mogą pracować równolegle

Podejście API-first obejmuje ustanowienie umowy. Utworzenie umowy między usługami, które jest przestrzegane przez zespoły w całej organizacji, pozwala tym zespołom pracować nad wieloma interfejsami API jednocześnie. Deweloperzy nie muszą czekać na wydanie aktualizacji interfejsu API przed przejściem do następnego interfejsu API. Zespoły mogą jednocześnie przeprowadzać testy mock-up interfejsów API i zależności interfejsów API na podstawie wstępnie ustalonych definicji interfejsów API.

Zmniejsza koszt rozwoju

Interfejsy API i kod można ponownie wykorzystać w wielu różnych projektach. W ramach podejścia API-first, jeśli zespół deweloperski chce zbudować nową aplikację, nie musi zaczynać od zera, oszczędzając czas i pieniądze. Projektowanie API-first pozwala również rozwiązać większość problemów przed napisaniem jakiegokolwiek kodu, co pomaga zapobiegać problemom w momencie integracji interfejsów API z aplikacjami.

Zwiększa szybkość wejścia na rynek

Większość procesu budowania interfejsów API można zautomatyzować za pomocą narzędzi do importowania plików definicji interfejsu API. Zaczynamy od generowania typów rdzenia, definicji i schematów; przy użyciu tych plików narzędzia interfejsu API, takie jak dokumentacja interfejsu API, zestawy programistyczne (SDK) i mock-up interfejsy API, mogą być generowane automatycznie. Automatyzacja znacznie przyspiesza rozwój interfejsów API i aplikacji.

API-first umożliwia również dodawanie nowych usług i technologii do aplikacji bez konieczności przeprojektowania całego systemu. Zonos musi dostarczać funkcje do produkcji szybko, aby pozostać konkurencyjnym na stale zmieniającym się rynku SaaS handlu zagranicznego. Łatwiej jest wyeliminować dług techniczny w kodzie bazowym niż migrować klientów ze źle zaprojektowanego interfejsu API.

Zapewnia dobre doświadczenie dla deweloperów

Konsumenci interfejsu API to najczęściej deweloperzy, a doświadczenie dewelopera (DX) może przesądzić o sukcesie interfejsu API. Podejście API-first zapewnia pozytywne doświadczenie dewelopera, ponieważ dobrze zaprojektowany, dobrze udokumentowany, spójny interfejs API jest łatwiejszy do nauki i ponownego wykorzystania. Zwiększa to również szybkość wdrażania. Wszystkie te korzyści są ze sobą połączone!

Zwiększa długoterminowy sukces

Podejście API-first pozwala na szybkie prototypowanie i iterację, co oznacza, że szybciej dowiadujemy się, co działa, a co nie. Podobnie jak w przypadku 1000 nieudanych prób Edisona przed stworzeniem żarówki, API-first oznacza, że szybko upadamy i idziemy naprzód z lepszym zrozumieniem, jak osiągnąć sukces. API-first zwiększa nasz długoterminowy sukces poprzez zapewnienie, że interfejsy API są niezawodne, spójne i łatwe w użyciu dla deweloperów.

Dlaczego praca wstecz jest skuteczna? 

W 2015 roku miałem okazję przeprojektować sklep internetowy popularnej marki konsumenckiej. Oceniłem różne kluczowe wskaźniki wydajności (KPI) związane z istniejącym systemem i było oczywiste, gdzie można było wprowadzić największe ulepszenia:

• Wskaźnik konwersji na pulpicie był poniżej standardu.
• Wskaźnik konwersji mobilnej był fatalny.
• Procent ruchu mobilnego szybko rósł i w ciągu następnych 12 miesięcy przekroczy 50% całkowitego ruchu. Ze względu na fatalny mobilny wskaźnik konwersji większość ruchu mobilnego nie była idealna.

Biorąc pod uwagę dane, co stworzyłoby największą wartość dla użytkowników? Było to oczywiste: naprawa problemów z doświadczeniem użytkownika mobilnego witryny. Dlatego zastosowałem podejście mobile-first do przeprojektowania witryny. Oznaczało to, że wszystkie projekty, architektura, interfejsy API itp. najpierw uwzględniały doświadczenie mobilne. Było to przeciwne do tradycyjnego podejścia w tamtym czasie, które skupiało się najpierw na doświadczeniu na pulpicie, często pozostawiając doświadczenie mobilne jako niezdarnie doczepiony dodatek ze słabymi wskaźnikami konwersji. Podejście mobile-first wymagało również większego wysiłku z góry – nie była to łatwa droga. Wymagana była nowa architektura, musiały być napisane nowe interfejsy API i wymagane były wielokrotne projekty dla każdego breakpointu.

Podejście mobile-first doprowadziło do znacznego wzrostu wskaźnika konwersji mobilnej. Nowa architektura również przyniosła imponujące zyski w wskaźniku konwersji na pulpicie. Podejście było skuteczne, ponieważ zidentyfikowało sposób stworzenia maksymalnej wartości dla użytkownika i skoncentrowało całe podejście na dostarczeniu tej wartości. Stworzyła to właściwą mentalność od samego początku. Podobnie – chociaż może się to wydawać pracą wstecz – podejście API-first stwarza możliwości identyfikacji ogólnych problemów, a następnie zbudowania fundamentu do ich rozwiązania.

Jaka jest odpowiedzialność inżynierii? 

Mentalność API-first doprowadziła i będzie nadal prowadzić Zonos do sukcesu, a inżynieria odgrywa integralną rolę. To nasza odpowiedzialność, aby zawsze utrzymać mentalność API-first. Oznacza to, że stale zadajemy pytania, które utrzymują fokus na naszych interfejsach API, takie jak: „W jaki sposób nasze interfejsy API mogą spełnić potrzeby klientów” Oznacza to również, że zawsze odpowiadamy na pytania dotyczące funkcji i funkcjonalności linkiem do naszej dokumentacji interfejsu API. Jeśli dokumentacja nie istnieje, tworzymy ją – pracując razem w zespołach międzyfunkcyjnych, aby zapewnić, że Zonos ma doskonałą dokumentację interfejsu API.