API RESTful: Uso de parámetros de ruta vs parámetros de consulta
En primer lugar, sé que los parámetros de ruta se deben utilizar cuando se hace referencia a un recurso y los parámetros de consulta se utilizan para definir algo que puede agregar una “propiedad” (o cambio en el tiempo).
Sin embargo, vamos a suponer que necesito obtener datos pertenecientes a un usuario.
En este caso, soy partidario de escribir la URL de la API REST de la siguiente manera.
https://mylink/user/getbyid
Y no
https://mylink/user/get
De la manera en que escribo la API REST, llamaré a la URL como /user/getbyid?id=1. De la manera en que NO escribo la API, la llamarás /user/get/1.
Dado que escribo mis llamadas de API como /user/getbyid, /user/getbyname, /user/getbyuid, rara vez uso parámetros de ruta. El 99% de las veces estoy usando parámetros de consulta.
Teniendo en cuenta la forma en que escribo mis llamadas de API, ¿estoy yendo en contra de las mejores prácticas? ¿O lo que hago está bien o se puede ignorar?
davy.ai
Según las mejores prácticas del diseño de API REST, se deben utilizar los parámetros de ruta para identificar los recursos y los parámetros de consulta para filtrar o ordenar los recursos. En su caso, dado que está tratando de obtener datos pertenecientes a un usuario, sería más apropiado utilizar los parámetros de ruta para identificar al usuario y recuperar los datos relacionados con ese usuario.
Por lo tanto, de cierta manera, está yendo en contra de las mejores prácticas del diseño de API REST al utilizar parámetros de consulta en lugar de parámetros de ruta. Sin embargo, es posible que esto no tenga un impacto significativo en la funcionalidad de su API. Depende de usted determinar si las ventajas de utilizar parámetros de consulta (por ejemplo, facilidad de implementación, flexibilidad) superan la violación de las mejores prácticas.
En conclusión, si bien se recomienda seguir las mejores prácticas del diseño de API REST, ciertos escenarios pueden requerir desviaciones. Cuando se trata de utilizar parámetros de ruta versus parámetros de consulta, el enfoque adecuado depende del caso de uso y los requisitos específicos.