Wpis z mikrobloga

Do zadania aplikacyjnego z java/spring mam zrobić w pliku readme:

krótki opis endpointów zawierający informacje o przyjętych regułach walidacji i akceptowalnych requestach


czyli o co chodzi? ( ͡° ͜ʖ ͡°) co ja mam opisać i jak? Macie jakieś przykłady itp.

#programowanie #java #it
  • 12
@puto: zamiast robienia głupich opisów endpointów wystaw im OpenAPI jak człowiek współczesny,

a reguły walidacji niech sobie sami wyklikają ( ͡° ͜ʖ ͡°)
@puto: widziałeś kiedyś co wypluwa z siebie swagger? to coś takiego

Jak masz np endpoint do uaktulniania adresu to piszesz, że ten enpoijy przyjmuje Jsona z obiektem adres o takich i takich polach
Pole ulica może mieć maksymalna długość 200 znaków, nie przyjmuje nulla i jest to pole wymagane, białe znaki na końcu stringa są wycinane i tak dla każdego pola w tym obiekcie
W przypadku podania złej wartości dla pola
@puto: wylistowujesz urle i jakie parametry przyjmują oraz jakie warunki musza spełniać. Czyli np GET /user/{email} i podajesz że email to string i musi zawierać @.
@puto: bo praca programisty to nie tylko klepanie samego kodu. Ofc teraz tego nie robi się recznie ale wciąż wiele innych rzeczy się opisuje. Chcą sprawdzić i ten zakres umiętności.
@puto: Niby tak, ale to pokazuje czy jesteś w stanie dokumentować w jakimkolwiek stopniu endpointy dla innych osób. A dobry swagger naprawdę ułatwia robotę.
@puto: chce to bo szuka kogoś więcej niż klepacza kodu który odbębni swoje bez dokumentacji itp. Prawdziwego specjalistę (niekoniecznie z wieloma latami expa) poznasz co sobą reprezentuje także poza kodem