Jak ujawnić API walidacji w sposób RESTful?
Jestem generalnie fanem projektowania API RESTful, ale nie jestem pewien, jak zastosować zasady REST dla API walidacji.
Załóżmy, że mamy interfejs API do wysyłania zapytań i aktualizowania informacji o profilu użytkownika (imię i nazwisko, adres e-mail, nazwa użytkownika, hasło). Uznaliśmy, że przydatnym elementem funkcjonalnym do wystawienia będzie walidacja, np. zapytać, czy dana nazwa użytkownika jest poprawna i dostępna.
Jakie są zasoby w tym przypadku? Jakich kodów statusu HTTP i / lub nagłówków należy użyć?
Na początek mamGET /profile/validate
który pobiera parametry ciągu znaków zapytania i zwraca204
lub400
jeśli jest ważny lub nieważny. Alevalidate
jest wyraźnie czasownikiem, a nie rzeczownikiem.