Enhance recommendation API to support X-API-Version header for score retrieval (#1140)

Author: zhenghaoz

server/rest.go

@@ -529,9 +529,10 @@ func (s *RestServer) CreateWebService() {
 		Returns(http.StatusOK, "OK", []cache.Score{}).
 		Writes([]cache.Score{}))
 	ws.Route(ws.GET("/recommend/{user-id}").To(s.getRecommend).
-		Doc("Get recommendation for user.").
+		Doc("Get recommendation for user. Set X-API-Version: 2 to return scores.").
 		Metadata(restfulspec.KeyOpenAPITags, []string{RecommendationAPITag}).
 		Param(ws.HeaderParameter("X-API-Key", "API key").DataType("string")).
+		Param(ws.HeaderParameter("X-API-Version", "API version (set to 2 to return scores)").DataType("string")).
 		Param(ws.PathParameter("user-id", "User ID").DataType("string")).
 		Param(ws.QueryParameter("category", "Category of the returned items (support multi-categories filtering)").DataType("string")).
 		Param(ws.QueryParameter("write-back-type", "Type of write back feedback").DataType("string")).
@@ -541,9 +542,10 @@ func (s *RestServer) CreateWebService() {
 		Returns(http.StatusOK, "OK", []string{}).
 		Writes([]string{}))
 	ws.Route(ws.GET("/recommend/{user-id}/{category}").To(s.getRecommend).
-		Deprecate().Doc("Get recommendation for user.").
+		Deprecate().Doc("Get recommendation for user. Set X-API-Version: 2 to return scores.").
 		Metadata(restfulspec.KeyOpenAPITags, []string{RecommendationAPITag}).
 		Param(ws.HeaderParameter("X-API-Key", "API key").DataType("string")).
+		Param(ws.HeaderParameter("X-API-Version", "API version (set to 2 to return scores)").DataType("string")).
 		Param(ws.PathParameter("user-id", "User ID").DataType("string")).
 		Param(ws.PathParameter("category", "Category of the returned items").DataType("string")).
 		Param(ws.QueryParameter("write-back-type", "Type of write back feedback").DataType("string")).
@@ -843,6 +845,7 @@ func (s *RestServer) getRecommend(request *restful.Request, response *restful.Re
 	}
 	// parse arguments
 	userId := request.PathParameter("user-id")
+	apiVersion := strings.TrimSpace(request.HeaderParameter("X-API-Version"))
 	n, err := ParseInt(request, "n", s.Config.Server.DefaultN)
 	if err != nil {
 		BadRequest(response, err)
@@ -900,6 +903,10 @@ func (s *RestServer) getRecommend(request *restful.Request, response *restful.Re
 		}
 	}
 	// Send result
+	if apiVersion == "2" {
+		Ok(response, scores)
+		return
+	}
 	Ok(response, results)
 }
 

server/rest_test.go

@@ -1010,6 +1010,18 @@ func (suite *ServerTestSuite) TestGetRecommends() {
 		Status(http.StatusOK).
 		Body(suite.marshal([]string{"1", "3", "5"})).
 		End()
+	apitest.New().
+		Handler(suite.handler).
+		Get("/api/recommend/0").
+		Header("X-API-Key", apiKey).
+		Header("X-API-Version", "2").
+		QueryParams(map[string]string{
+			"n": "3",
+		}).
+		Expect(suite.T()).
+		Status(http.StatusOK).
+		Body(suite.marshal([]cache.Score{{Id: "1", Score: 99}, {Id: "3", Score: 97}, {Id: "5", Score: 95}})).
+		End()
 	apitest.New().
 		Handler(suite.handler).
 		Get("/api/recommend/0").