Makiety API

Prototypowanie API

Pierwszym przypadkiem użycia makiet API jest prototypowanie API. Chodzi o to, że po zakończeniu iteracji projektowania API chcesz uzyskać opinie od różnych interesariuszy w projekcie API: członków zespołu, programistów, którzy będą korzystać z API, właścicieli produktów itp.

Jeśli interesariusze mogą faktycznie wchodzić w interakcję z projektem API, istnieje większe prawdopodobieństwo, że uzyskasz lepsze opinie i to szybciej, ponieważ doświadczenie przeglądania API jest bardziej wciągające i realistyczne.

Równoległa implementacja frontendu i backendu

W wielu projektach, po zakończeniu fazy projektowania API, konieczne będzie napisanie zarówno kodu backendu w celu implementacji API, jak i kodu frontendu, który będzie z niego korzystał.

Po ustaleniu kontraktu API nie ma rzeczywistego powodu, dla którego programiści frontendu mieliby czekać na zakończenie prac przez programistów backendu przed rozpoczęciem swoich. Postępowanie w tak liniowy sposób wydłuży czas wprowadzania na rynek i spowolni cykle informacji zwrotnych między zespołami backendu i frontendu podczas programowania.

Posiadanie makiety API, która jest na bieżąco z najnowszym projektem kontraktu API, umożliwia zespołom frontendu i backendu równoległą pracę.

Negocjacja treści

Jedynym dynamizmem zapewnianym przez makiety jest negocjacja treści. Jeśli w API zdefiniowano wiele ciał, a żądanie zostanie wykonane ze zgodnym typem nośnika w nagłówku Accept, makieta użyje tego ciała do utworzenia odpowiedzi.

Testowanie makiety

Możesz przetestować swoją makietę za pomocą dowolnego klienta API, takiego jak API Tester, Postman lub cURL, wysyłając żądania na adres URL punktu końcowego makiety wyświetlany w API Designer.