Comment créer une API REST avec des paramètres optionnels?

Question

Je dois implémenter une API avec ces paramètres de chemin.

@Path("/job/{param1}/{optional1}/{optional2}/{param2}") 

Les deuxième et troisième paramètres peuvent-ils être optionnels? Donc, le client n'a pas besoin de passer ces derniers, mais doivent passer le premier et le dernier.

Si cela n'est pas possible, alors est-il recommandé de réorganiser les paramètres de cette façon?

@Path("/job/{param1}/{param2}/{optional1}/{optional2}") 

Comment fournir les paramètres facultatifs?

Answer 1

Vous pouvez faire correspondre le chemin complet se termine par la demande REST

@Path("/location/{locationId}{path:.*}") 
public Response getLocation(
    @PathParam("locationId") int locationId, 
    @PathParam("path") String path) { 
    //your code 
} 

Maintenant, la variable de chemin contient chemin entier après location/{locationId}

Vous pouvez également utiliser des expressions régulières pour faire chemin facultatif.

@Path("/user/{id}{format:(/format/[^/]+?)?}{encoding:(/encoding/[^/]+?)?}") 
public Response getUser(
    @PathParam("id") int id, 
    @PathParam("format") String format, 
    @PathParam("encoding") String encoding) { 
    //your code 
} 

Maintenant, si le formatage et l'encodage sont optionnels. Vous ne donnez aucune valeur, ils seront vides.

Answer 2

Réorganiser les params et les opérations suivantes:

@Path("/job/{param1}/{param2}{optional1 : (/optional1)?}{optional2 : (/optional2)?}") 
public Response myMethod(@PathParam("param1") String param1, 
         @PathParam("param2") String param2, 
         @PathParam("optional1") String optional1, 
         @PathParam("optional2") String optional2) { 
    ... 
} 

Answer 3

Il pourrait être plus facile de tourner les paramètres de chemin en option dans les paramètres de la requête. Vous pouvez ensuite utiliser @DefaultValue si vous en avez besoin:

@GET @Path("/job/{param1}/{param2}") 
public Response method(@PathParam("param1") String param1, 
    @PathParam("param2") String param2, 
    @QueryParam("optional1") String optional1, 
    @QueryParam("optional2") @DefaultValue("default") String optional2) { 
    ... 
} 

Vous pouvez ensuite appeler à l'aide /job/one/two?optional1=test passant uniquement les paramètres facultatifs dont vous avez besoin.