Formato de publicación REST

Question

Cuando utiliza REST para crear una nueva entrada usando una POST, veo que algunas API como Google's especifican que envía XML como parte de la solicitud, mientras que otras especifican que envía pares clave/valor. ¿Existe un estándar o una mejor práctica para REST POST-s?

Answer 1

Depende del implementador del servicio REST.

Si el servicio REST es una adaptación de un formato html HTML existente, generalmente es más fácil comenzar con pares de valores de clave de publicación.

Al publicar información de JavaScript, generalmente es más fácil usar JSON.

XML se usa a menudo porque es fácil de entender para los humanos y hay montones de herramientas en cada idioma/plataforma que pueden manejarlo.

Answer 2

Cualquier formato de representación que funcione está bien, con la condición de que intente utilizar formatos estándar como Atom, donde existan.

actualización He aquí una relevant quote de Roy Fielding (co-autor de la norma HTTP, y la persona que articula descansar en su tesis de doctorado). La forma de diseñar las representaciones utilizadas en el servicio web es de importancia central:

Una API REST debe pasar la mayor parte de su esfuerzo descriptiva en la definición de el tipo (s) de comunicación utilizado para recursos que representan [.. .]

Asegúrese de leer el seguimiento de Q & A.

Answer 3

SOAP es el estándar para servicios web (creo que estás un poco confundido bewteen servicios Web y REST).

Pero realmente depende de los implementadores.

Answer 4

Sugiero usar lo más simple porque de eso se trata REST. El siguiente fragmento de código es cómo hago una publicación. Sé que no estabas buscando código específicamente, pero la API a continuación (httpClient) funciona muy bien. Luego decodifica usando las herramientas que los codificadores siempre hemos usado (request.getParameter()). Creo que esto es lo que distingue a REST de SOAP. No lo hagas difícil! Use HTTP!

public void testHttpClient() { 
    PostMethod pMethod = null; 
    pMethod = new PostMethod("...url..."); 
    NameValuePair[] data = {new NameValuePair("activeFlag", "yes"), new NameValuePair("custCode", "B010"), new NameValuePair("comments", "mark is cool")}; 
    pMethod.setRequestBody(data); 
    this.makeCall(pMethod); 
} 
private String makeCall(HttpMethod method) { 
    String response = null; 
    HttpClient client = new HttpClient(); 
    client.getParams().setAuthenticationPreemptive(true); 
    client.getState().setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(this.logon, this.pass)); 
    method.getParams().setParameter(HttpMethodParams.RETRY_HANDLER, new DefaultHttpMethodRetryHandler(3, false)); 
    method.getParams().setIntParameter(HttpMethodParams.SO_TIMEOUT, 5000); 
    try { 
     int statusCode = client.executeMethod(method); 
     if (statusCode != HttpStatus.SC_OK) { 
      System.err.println("Method failed: " + method.getStatusLine()); 
     } 
     String aLine = null; 
     StringBuffer sb = new StringBuffer(); 
     BufferedReader in = new BufferedReader(new InputStreamReader(method.getResponseBodyAsStream())); 
     while ((aLine = in.readLine()) != null) { 
      sb.append(aLine.trim()); 
      System.out.println(aLine); 
     } 
     in.close(); 
     response = sb.toString(); 
    } catch (HttpException e) { 
     System.err.println("Fatal protocol violation: " + e.getMessage()); 
     e.printStackTrace(); 
    } catch (IOException e) { 
     System.err.println("Fatal transport error: " + e.getMessage()); 
     e.printStackTrace(); 
    } finally { 
     method.releaseConnection(); 
    } 
    return response; 
}