Implementacja REST Api przy użyciu Spring

Question

Jedną z najlepszych praktyk pisania aplikacji RESTFul api jest dodanie wersji. na przykład:

http://my-server/api/v1/getData 
http://my-server/api/v2/getData 

Nasza aplikacja udostępnia REST api przy użyciu frameworka Spring. Oznaczamy klasę jako kontroler, używamy adnotacji RequestMapping do mapowania adresu URL do funkcji i dodawania obiektów, które są tłumaczone na/z obiektów json.

Na przykład:

@RequestMapping(method = RequestMethod.POST, value = "/api/v1/getData") 
public @ResponseBody ResponseDataDTO getData(@RequestBody OperationsDetailsTDO details) {...} 

Teraz chcemy zapewnić drugą wersję API. Około 2/3 funkcji pozostaje bez zmian, a 1/3 się zmienia. Zmiany są zarówno w logice, jak i obiektach JSON.

Zastanawiam się, jak zaprojektować kod. Myślę, że ten rodzaj kodu jest trudna do zarządzania:

@RequestMapping(method = RequestMethod.POST, value = "/api/{version-var}/getData") 
public @ResponseBody ResponseDataDTO createReleaseFromTemplate(@PathVariable("version-var") Integer version, @RequestBody OperationsDetailsTDO details) { 
if (version == 1) 
{ 
    doForVersion1(); 
} 
else if (version == 2) 
{ 
    doForVersion2(); 
} 

} 

To będzie trudne do zarządzania, ponieważ w każdej funkcji nie będzie inaczej rozgałęzienia. Aby zademonstrować problem, jeśli mam automatyczne narzędzie, które generuje dokumentację, nie będzie w stanie zrozumieć, czym jest API.

Po drugie, zastanawiam się, co powinienem zrobić z klasami związanymi z obiektem JSON. Czy muszę zduplikować wszystkie te klasy, aby wprowadzić drobne zmiany?

Thx.

Answer 1

Zgadzam się z Tobą w sprawie uchwalenia wersję jako parametr, podobnie jak

@RequestMapping(method = RequestMethod.POST, value = "/api/{version-var}/getData") 

Ale nie sądzę, że to dobry pomysł, aby dodać wiele oddziałów, Trzeba wyodrębnić wszystkie metody w klasie zasobów do interfejsu biznesowego, takiego jak

private IDataRetrieve dataRetriever; 
@RequestMapping(method = RequestMethod.POST, value = "/api/{version-var}/getData") 
public @ResponseBody ResponseDataDTO createReleaseFromTemplate(@PathVariable("version-var") Integer version, @RequestBody OperationsDetailsTDO details) { 
    dataRetiever = DataRetrieverFactory.getDataTrieverByVersion(version); //TODO, create a factory to get DataRetriever 
    return dataRetiever.getData(); 
} 

a potem trzeba dwa zaklasyfikowane do wdrożenia IDataRetriver, (jeden dla V1, inny dla V2); przyczyny, aby uniknąć powielenia kodu, możesz dodać klasę abstrakcyjną dla V1 i V2 i użyć szablonu Patern, aby usunąć zduplikowany kod.

Answer 2

Możesz używać wyrażeń regularnych w mapowaniu zapytań, jeśli używasz zmiennej ścieżki dla wersji (see here for example). Można też utworzyć nową metodę, która po prostu wywoła stary, ale ma nowszą funkcję RequestMapping dla wersji 2. Lub utwórz ogólną metodę, która pobiera wersję i wywołuje właściwą metodę, która faktycznie obsługuje tę wersję żądania. Bonus za ostatnią metodę: możesz pobrać wersję i wysłać użytkownika do określonego błędu, jeśli wysłana wersja nie jest obsługiwana, na przykład jeśli wysyłają/app/v10/cokolwiek innego.