¿Está bien que REST devuelva el contenido después del POST?

Question

Estoy usando RESTlet y he creado un recurso. Manejo el POST anulando el método acceptRepresentation.

El cliente debe enviarme algunos datos, luego los almaceno a DB, establezco la respuesta a 201 (SUCCESS_CREATED) y debo devolver algunos datos al cliente, pero el tipo de devolución de acceptRepresentation es nulo.

En mi caso, tengo que devolver algún identificador para que el cliente pueda acceder a ese recurso.

Por ejemplo, si tuviera un recurso con URL/recurso y el cliente envía una solicitud POST, agrego una nueva fila en DB y su dirección debe ser/resource/{id}. Necesito enviar {id}.

¿Estoy haciendo algo mal? ¿Los principios de REST permiten devolver algo después del POST? En caso afirmativo, ¿cómo puedo hacerlo? Si no, ¿cuál es la forma de manejar esta situación?

Answer 1

REST simplemente dice que debe ajustarse a la interfaz uniforme. En otras palabras, dice que debe hacer lo que se supone que debe hacer POST según el HTTP spec. Aquí está la cita de esa especificación que es relevante,

Si un recurso se ha creado en el servidor origen, la respuesta debería sea 201 (Creado) y contiene una entidad que describe el estado de la solicitud y se refiere al nuevo recurso , y un encabezado Location (ver sección 14.30).

Como puede ver en esto, tiene dos lugares donde puede indicar al cliente dónde reside el recurso recién creado. El encabezado de ubicación debe tener una URL que apunta al nuevo recurso y también puede devolver una entidad con los detalles.

No estoy seguro de cuál es la diferencia entre reemplazar acceptRepresentation() y anular la publicación() pero el ejemplo this muestra cómo devolver una respuesta desde una POST.

Answer 2

Extiéndalo en el formato que se solicite. Eso podría ser:

<success> 
    <id>5483</id> 
</success> 

O:

{ "type": "success", "id": 5483 } 

Depende de lo que suele hacer. Si no están esperando los datos, simplemente deberían ignorarlos, pero cualquier cliente que quiera manejarlos correctamente debería poder hacerlo.

Answer 3

dos cuestiones diferentes:

¿Es compatible el patrón de aplicación REST devolver datos en un post?

No creo que REST lo desautorice explícitamente, pero el tratamiento preferido se detalla en la respuesta de Darrel.

¿El marco RESTlet permite devolver datos en un POST?

Sí, aunque devuelve vacío, en una clase que amplía Recurso, tiene acceso completo al objeto Objeto de respuesta a través del método getResponse(). Entonces puede llamar a getResponse(). SetEntity() con los datos que desee.

Answer 4

Si respondes 201 Creado con un cuerpo de entidad, en lugar de una ubicación de redirección, entonces es una buena idea incluir una cabecera Content-Location señalando el recurso que se está representando en la respuesta.

Esto evitará la posible confusión - en el que un cliente podría (justificadamente) asumir que la entidad respuesta en realidad representa un nuevo estado del 'creador', y no el recurso creado.

> POST /collection 
> ..new item.. 

< 201 Created 
< Location: /collection/1354 
< Content-Location: /collection/1354 
< <div class="item">This is the new item that was created</div> 

Answer 5

Me forgo enviar nada en el cuerpo de la respuesta. Simplemente configure Ubicación: en la URL (completa) del recurso recién creado.

Su descripción sugiere que esta es exactamente la semántica usted:

1. POST de una cosa para crearlo
2. responden con suficiente saber dos cosas:
   1. Eso sucedió la creación (el 201)
   2. Dónde encontrar lo nuevo (la cabecera Location)

Todo lo demás es superfluo. respuesta