[rest] REST URI의 버전을 지정하는 방법

API 버전 관리에는 4 가지 접근 방식이 있습니다.

• URI 경로에 버전 추가 :

  http://example.com/api/v1/foo
  
  http://example.com/api/v2/foo
  

  주요 변경 사항이있는 경우 v1, v2, v3 …과 같은 버전을 늘려야합니다.

  다음과 같이 코드에서 컨트롤러를 구현할 수 있습니다.

  @RestController
  public class FooVersioningController {
  
  @GetMapping("v1/foo")
  public FooV1 fooV1() {
      return new FooV1("firstname lastname");
  }
  
  @GetMapping("v2/foo")
  public FooV2 fooV2() {
      return new FooV2(new Name("firstname", "lastname"));
  }
  

• 매개 변수 버전 관리 요청 :

  http://example.com/api/v2/foo/param?version=1
  http://example.com/api/v2/foo/param?version=2
  

  버전 매개 변수는 API 사용 방법에 따라 선택 사항이거나 필수 일 수 있습니다.

  구현은 다음과 유사 할 수 있습니다.

  @GetMapping(value = "/foo/param", params = "version=1")
  public FooV1 paramV1() {
      return new FooV1("firstname lastname");
  }
  
  @GetMapping(value = "/foo/param", params = "version=2")
  public FooV2 paramV2() {
      return new FooV2(new Name("firstname", "lastname"));
  }
  

• 사용자 정의 헤더 전달 :

  http://localhost:8080/foo/produces
  

  헤더 포함 :

  headers[Accept=application/vnd.company.app-v1+json]
  

  또는:

  headers[Accept=application/vnd.company.app-v2+json]
  

  이 체계의 가장 큰 장점은 대부분 의미 체계입니다. 버전 관리와 관련하여 URI를 복잡하게 만들지 않습니다.

  가능한 구현 :

  @GetMapping(value = "/foo/produces", produces = "application/vnd.company.app-v1+json")
  public FooV1 producesV1() {
      return new FooV1("firstname lastname");
  }
  
  @GetMapping(value = "/foo/produces", produces = "application/vnd.company.app-v2+json")
  public FooV2 producesV2() {
      return new FooV2(new Name("firstname", "lastname"));
  }
  

• 호스트 이름 변경 또는 API 게이트웨이 사용 :

  기본적으로 한 호스트 이름에서 다른 호스트 이름으로 API를 이동합니다. 이 빌드를 동일한 리소스에 대한 새 API를 호출 할 수도 있습니다.

  또한 API 게이트웨이를 사용하여이 작업을 수행 할 수 있습니다.

답변