Pomiędzy

W tej części tutoriala zajmiemy się interfejsem programistycznym aplikacji. Jak się okazuje, duża część naszego API jest już gotowa. Narzędziem, którym możemy się do niego odnieść jest cURL.

Możemy uruchomić w tej chwili terminal i przy włączonym serwerze, użyć komendy wysyłającej zapytanie z metodą GET na ścieżkę /students serwera, oczekując listy wszystkich znajdujących się w bazie studentów w formacie JSON (application/json).

• curl -X GET -H "Accept: application/json" "http://localhost:3000/students"

Powinniśmy otrzymać wynik podobny do poniższego.

[
   {
      "id":1,
      "index":"123456",
      "name":"Zenon",
      "created_at":"2017-11-21T18:47:54.435Z",
      "updated_at":"2017-11-21T22:44:27.825Z",
      "url":"http://localhost:3000/students/1.json"
   },
   {
      "id":2,
      "index":"654321",
      "name":"Marian",
      "created_at":"2017-11-21T18:47:54.509Z",
      "updated_at":"2017-11-21T18:47:54.509Z",
      "url":"http://localhost:3000/students/2.json"
   }
]

Interfejs programistyczny wymaga jednak wprowadzenia kilku poprawek w projekcie. Po pierwsze, w wypadku metod zabezpieczonych barierą logowania, nie będziemy za każdym razem przesyłać aktualnych plików ciastek. Przygotujemy osobną procedurę uzyskiwania tokena, dzięki któremu będziemy mogli identyfikować się w systemie. Poza tym, jeśli do naszego systemu ma powstać aplikacja mobilna, należy odpowiednio udokumentować API. Uczynimy to za pomocą narzędzia Swagger.