Leer este articulo de Mark Pilgrim y este.
Categoría: atom
AtomAPI es un protocolo para publicar y editar recursos de web. Usa las operaciones comunes de HTTP (GET, PUT, POST y DELETE).
* GET is used to retrieve a representation of a resource or perform a read-only query.
* PUT is used to update a known resource.
* POST is used to create a new dynamically-named resource.
* DELETE is used to remove a resource.
Hay diferentes recursos que maneja el AtomAPI, cada uno de estos tiene URIs y estas soportan un subconjunto de los metodos mencionados anteriormente.
Las tres principales clases de URIs (junto a su subconjunto de operaciones) son:
* EditURI: PUT, GET, DELETE
* PostURI: POST
* FeedURI: GET
Observar que esto no limita a una URI solo usar estos metodos (la EditURI puede soportar POST por ejemplo)
PostURI
Es usado para crear entradas (articulo en un weblog, comentarios o una pagina wiki por ejemplo). El cliente publica (POST) una entrada Atom en esta URI. Si su pedido es correcto entonces multioples nuevas URIs pueden ser creadas que contengan representaciones de varios tipos.
Localizador
Para crear una nueva entrada se usa la etiqueta link, quien apunta a el PostURI del sitio.
<link rel="service.post"= type="application/x.atom+xml" href="URI for Posting goes here" title="The name of the site.">
Pedido
El pedido contiene una linea en la entrada Atom
Respuesta
Los codigos de estado esperados de un POST son are 201, 303, 400, y 500. 401, 404, y 410.
EditURI
Una EditURI es usada para editar una unica entrada. Cada entrada editable debe tener un unico URI. Esta URI soporta GET y PUT y son usadas en combinacion para un ciclo de edicion. El cliente toma con un GET la representacion formateada como una entrada Atom. El cliente debe actualizar la entrada y entonces con PUT colocarla nuevamente en la misma URI.
Un cliente puede enviar un DELETE a el EditURI para eliminar la entrada.
Localizador
Para editar una entrada se usa la etiqueta link.
<link rel="service.edit" type="application/x.atom+xml" href="URI for Editing goes here" title="Readable description of the entry.">
Pedido
Tanto un pedido PUT como una respuesta GET contienen una linea en la entrada Atom.
FeedURI
El FeedURI es usado para obtener una representacion en formato Atom. Contiene elmentos "link" para navegar y maniuplar el contenido del sitio.
Localizador
Una etiqueta link con el siguiente formato apunta a el FeedURI:
<link rel="service.feed" type="application/x.atom+xml" href="URI goes here" title="The name of the site.">
Pedido
El pedido es simplemente un GET.
Respuesta
Los codigo de estado esperados de un GET son 200, 301, 307, y 500. 401, 404, y 410.
Etiqueta Link
Esta etiqueta es usada tanto en el formato html como Atom con algunas pequenias diferencias.
La etiqueta link en los documentos HTML aparece en el cabezal (head) de los documentos, la cual solo permite una lista lineal de etiquetas link. El formato Atom permite etiquetas 'link' como hijos de tanto el elemento 'feed' como el 'entry'.
-> Atributo rel
Describe la relacion entre el actual documento (tanto sea HTML como Atom) con el href. El valor de este atributo es una lista, separada por espacios, de tipos de link. Si type="application/x.atom+xml" tenemos las siguientes interpretaciones de las relaciones:
alternate
La URI en href apunta a una representacion alternativa del recurso.
start
El feed Atom de la URI que esta en href contiene el primer feed en una secuencia lineal de entradas
next
El feed Atom de la URI en href contiene las siguientes N entradas en una secuencia lineal de entradas.
prev
El feed Atom de la URI en href contiene las anteriores N entradas en una secuencia lineal de entradas.
service.edit
La URI dada en href es usada para editar una representacion del recurso referido.
service.post
La URI en el href es usada para crar nuevos recursos.
service.feed
La URI dada en href es un punto de partida para navegar contenido y servicios.
-> Atributo href
URI del recurso que se descibe en el elemento link
-> Atributo title
Ofrece informacion sobre el link.
-> Atributo type
El tipo de contenido del recurso disponible en la URI dada en el atributo href del elemento link. La mayoria de los tipos de link en esta especificacion son tipo 'application/x.atom+xml'.
Nota: [Este texto es un super-resumen de las Especificaciones en castellano]
[Atom API Quick Reference - Ultima actualizacion]
