Restful的API Versioninging服務

Question

all！

我在Rest標題中檢查版本API的服務，我使用Java語言和Jersey框架。請求中沒有URI唯一標頭（POST，GET，PUT和DELETE）。看到下面的例子。

示例： GET/Employee 標頭 - 版本：1.0 < - 這是我需要在版本服務中實現的標頭。

有人有提示或通過我的文章和教程。

非常感謝。

Answer 1

在面向REST的面向資源的架構風格下，您將自己版本化資源，而不是服務。您可以通過使用定製版本化媒體類型來實現此目的。例如，使用Java和JAX-RS，可能是這個樣子：

@Path("/resource/account/{id}") 
@GET 
@Produces("application/vnd.mycompany.account-1.0+json") 
public Response getAccount(@PathParam("id") String id) { 
    ... 

注意在@Produces註釋媒體類型字符串的版本號。

然後，在你的客戶，當你發出請求，你用Accept頭指定您希望給定的媒體類型：

Accept: application/vnd.mycompany.account-1.0+json 

換句話說，不這樣做：

@Path("/resource/account/v1/{id}") 

如果要支持多個版本的服務類可能是這樣的：

@Path("/resource/account") 
public class AccountWebService { 

    @GET 
    @Path("/{id}") 
    @Produces("application/vnd.mycompany.account-1.0+json") 
    public Response getAccount(@PathParam("id") String id) { 
    ... 

    @GET 
    @Path("/{id}") 
    @Produces("application/vnd.mycompany.account-2.0+json") 
    public Response getAccountV2(@PathParam("id") String id) { 
    ... 

擺在我們最好將媒體類型拉出到公共靜態，以便我們可以從我們的測試客戶端訪問和使用它們。確保使用JerseyTest作爲您的單元測試的一部分來測試您的Web服務。