REST API - HerbMat/PetFinder GitHub Wiki

Tutaj znajdziesz opis usług REST API udostępnianych przez aplikację. Wszystkie usługi przyjmują oraz zwracają wiadomości w formacie JSON, w związku z czym każde zapytanie powinno być opatrzone nagłówkami:

  • Content-Type: application/json
  • Accept: application/json

Spis treści

Użytkownicy

Rejestracja użytkownika

POST /api/user

Parametry POST zapytania

Parametr Opis
login Login użytkownika
email Adres email użytkownika
password Hasło użytkownika
repeatPassword Powtórzenie hasła użytkownika

Przykładowe ciało zapytania

{
    "login": "login_uzytkownika",
    "email": "[email protected]",
    "password": "mojehaslo",
    "repeatPassword": "mojehaslo"
}

Odpowiedzi

Szczegóły dotyczące formatu odpowiedzi: Ogólny format odpowiedzi.

  • Utworzono użytkownika

    HTTP 201 Created

    {
    "message": "",
    "responseCode": 0,
    "status": "registered",
    "responseObject": {}
}

  • Nieprawidłowy format adresu email

    HTTP 400 Bad Request

    {
    "message": "Given email address is invalid.",
    "responseCode": 1,
    "status": "invalid email",
    "responseObject": {}
}

  • Podany login istnieje w bazie danych

    HTTP 400 Bad Request

    {
    "message": "User '...' already exists.",
    "responseCode": 2,
    "status": "login exists",
    "responseObject": {}
}

  • Podany email istnieje w bazie danych

    HTTP 400 Bad Request

    {
    "message": "Email '...' is already used.",
    "responseCode": 3,
    "status": "email exists",
    "responseObject": {}
}

  • Hasła nie zgadzają się

    HTTP 400 Bad Request

    {
    "message": "Passwords does not match.",
    "responseCode": 4,
    "status": "passwords does not match",
    "responseObject": {}
}

Ogłoszenia

Lista ostatnich ogłoszeń

/api/advertisement/latest

/api/advertisement/latest/{page}

Parametry URI zapytania

Parametr Opis
page Strona wyników (opcjonalnie)

Odpowiedzi

Jako odpowiedź otrzymujemy listę 20 ogłoszeń z danej strony wyników w formacie JSON (pola obiektów zgodne z modelem com.petfinder.domain.Advertisement) z kodem statusu HTTP 200 OK.

Standardowe odpowiedzi

Ogólny format odpowiedzi

{
    "message": "",
    "responseCode": 0,
    "status": "some status",
    "requestObject": {}
}
Parametr Opis
message Długa wiadomość opisująca wynik zapytania.
responseCode Kod odpowiedzi. 0 dla sukcesu, pozostałe wartości dla błędów.
status Krótki opis odpowiedzi.
requestObject Obiekt przesłany w zapytaniu, o ile istnieje.