Blog

Oszczędzaj swój czas z LocalAPI

23.07.2015

A PI jeszcze niegotowe? — czy właśnie to zdanie sprawia, że przerażony budzisz się w środku nocy? Ten moment, gdy backendowcy nadal pracują, a webdeveloperzy i testerzy chcą ruszyć z kolejnymi taskami… Ten stan, gdy API istnieje, ale nie ma jeszcze danych, na których mogłoby operować… Bezcenne, prawda? Znamy to, znamy. A raczej znaliśmy, bo skończyliśmy prace nad LocalAPI.

Z czym się to LocalAPI je? Zacznijmy od początku. To nasza autorska aplikacja oparta o Node.js, która uruchamia mockowe API na podstawie definicji w pliku RAML. Coś jeszcze? Jasne. Generuje przykładowe dane z szablonów napisanych w JavaScript. Dlaczego w trakcie prac wybraliśmy właśnie RAML? Bo RESTful API Modeling Language jest językiem pozwalającym opisać interfejs API w jasny i przystępny sposób. Taki opis oparty jest o standardy YAML i JSON, co sprawia, że jest zrozumiały zarówno dla ludzi, jak i komputerów. Fajnie?

Fajnie. No dobrze, ale jak działa nasze LocalAPI? Do jego uruchomienia i funkcjonowania niezbędny jest plik RAML oraz szablony generujące przykładowe dane. Ścieżka do pliku RAML jest przekazywana jako parametr w trakcie startu aplikacji. Plik RAML i jego pliki komplementarne muszą być umieszczone w konkretnej strukturze katalogu:

/raml – parent directory

  • /assets – additional files
  • /examples – dummy data JSON files generated from templates
  • /static_examples – static dummy data JSON files
  • / schemas – JSON schemas
  • /templates – data templates for dummy data generator
  • {YOUR_RAML_FILENAME}.RAML – the RAML file

Po starcie aplikacji tworzony jest folder /examples lub (jeśli już istnieje) zostaje on całkowicie opróżniony. Następnie powstają nowe, przykładowe pliki na bazie plików *.js z folderu /templates, a LocalAPI zaczyna pracę na podstawie pliku RAML. Za każdym razem, gdy uruchamiasz LocalAPI, na bazie szablonów tworzone są nowe pliki, ale możesz też używać statycznych przykładów jako odpowiedzi w Twoim API. Są one umieszczone w folderze /static_examples i pozostają bez zmian — bez względu na to, jak wiele razy zdecydujesz się restartować aplikację.

Szablony LocalAPI tworzone są w JavaScript. Poniżej możesz zobaczyć przykładowy szablon generujący plik JSON, który zawiera obiekt “user”:

LocalAPI1

Gdy LocalAPI przeprocesuje szablon, w folderze /examples możemy otrzymać następujący obiekt: “user”:

LocalAPI2

Proste prawda? Jeśli chcesz sprawdzić, jak nasze LocalAPI zmieni Twój dzień pracy już dziś pobierz je z GitHuba. Przygotowaliśmy tutorial, który wyjaśni Ci, jak zainstalować aplikację oraz jak wygenerować przykładowe dane. Mamy nadzieję, że i Tobie LocalAPI pomoże rozwiązać problem czasu traconego w oczekiwaniu na w pełni gotowe API. Teraz, nad kolejnymi zadaniami możesz pracować bez żadnych ograniczeń!

Anna Armatys

Employer Branding & Marketing Specialist

Organizuje, tworzy, wymyśla. Od prawie 3 lat jako Employer Branding & Marketing Specialist opiekuje się marką SoInteractive. Ukończyła Marketing Międzynarodowy na UEK oraz Marketing Internetowy na AGH. Uważa, że nie ma rzeczy niemożliwych, ani projektów, których nie da się zrealizować. Specjalizuje się rozwiązaniach grywalizacyjnych z zakresu HR i EB.

Zobacz również