Atom Publishing Protocol

Atom Publishing Protocol RFC 5023

Application-Level Protokoll zum Veröffentlichen und Editieren von Web-Resourcen
baut auf HTTP & XML (Atom Format) auf
Ziel: Vereinheitlichung der Verwaltung von Content in Verteilten Systemen

Ermöglicht Erzeugen, Lesen, Editieren, Löschen von Resourcen

Bedeutung

Blogging

WordPress

Google Data APIs (GData)

Youtube, Blogger, Picasa Gallery, Google Docs

weitere Seiten

z.B. http://www.feedbooks.com/

Joe Gregorio: „APP is a failure“

http://bitworking.org/news/425/atompub-is-a-failure
fat client vs. browser

Definitionen

Definitionen aus HTTP:

URI / IRI: Uniform / International Resource Identifier (RFC 3986)
Resource: netzwerk-zugängliches Datenobjekt
Representation: Darstellung des Datenobjekts

Definitionen

Collection: Eine Menge an Resourcen. Dargestellt als Atom Feed.
Member Resource: Resource, die in einer Collection mit der Relation „edit“ oder „edit-media“ gelistet ist

Entry Resource: Repräsentation als Atom Entry
Media Resource: andere Repräsentation
Media Link Entry: eine Entry Resource, die Metadaten über eine Media Resource enthält

Relation: „rel“ Attribut eines atom:link Elements

Definitionen

Service Document: Beschreibung von einer oder mehr Workspaces
Workspace: Gruppe von Collections
Category Document: Beschreibung der erlaubten Kategorien in einer Collection

Service Documents

Wie Service Documente gefunden werden ist nicht spezifiziert
Mime Type „application/atomsvc+xml“

Service Documents <? xml version = "1.0" encoding = 'utf-8' ?> < service xmlns = " http://www.w3.org/2007/app " xmlns:atom = "http://www.w3.org/2005/Atom" > < workspace > < atom:title > Main Site </ atom:title > < collection href = "http://example.org/blog/main" > < atom:title > My Blog Entries </ atom:title > < categories href = "http://example.com/cats/forMain.cats" /> </ collection > < collection href = "http://example.org/blog/pic" > < atom:title > Pictures </ atom:title > < accept > image/png </ accept > < accept > image/jpeg </ accept > < accept > image/gif </ accept > </ collection > </ workspace > </ service >

Service Documents <? xml version = "1.0" encoding = 'utf-8' ?> < service xmlns = " http://www.w3.org/2007/app " xmlns:atom = "http://www.w3.org/2005/Atom" > < workspace > < atom:title > Sidebar Blog </ atom:title > < collection href = "http://example.org/sidebar/list" > < atom:title > Remaindered Links </ atom:title > < accept > application/atom+xml;type=entry </ accept > < categories fixed = "yes" > < atom:category term = "joke" scheme = " http://example.org/extra-cats/ " /> < atom:category term = "serious" scheme = " http://example.org/extra-cats/ " /> </ categories > </ collection > </ workspace > </ service >

Collection lesen

Atom Format (RFC 4287)
Menge von Resourcen

geordnet nach app:edited

Mime Type application/atom+xml

Collection <? xml version = "1.0" encoding = "utf-8" ?> < feed xmlns = "http://www.w3.org/2005/Atom" > < title > Example Feed </ title > < link href = "http://example.org/" /> < updated > 2003-12-13T18:30:02Z </ updated > < author > < name > John Doe </ na me > </ author > < id > urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6 </ id > < entry > < title > Atom-Powered Robots Run Amok </ title > < link href = "http://example.org/2003/12/13/atom03" /> < id > urn:uuid:1225c695-cfb8-4ebb- aaaa -80da344efa6a </ id > < updated > 2003-12-13T18:30:02Z </ updated > < summary > Some text. </ summary > </ entry > </ feed >

Methoden Operation HTTP Methode create POST read GET update PUT delete DELETE

Anlegen / POST

POST der Representation an die URI der Collection

gewünschter Titel im SLUG HTTP-Header
Falls Representation kein atom:entry, dann Media Entry & Media Link Entry

Location Header im Response enthält neue URI

Lesen / GET

GET auf die Member URI
Representation wird zurückgegeben

atom:entry falls Entry Member
Sonst andere Representation

404 File not Found, falls Resource nicht vorhanden

Update / PUT

PUT an die Member URI ändert den bisherigen Eintrag

Client sollte gesamte Representation schicken, nicht nur Änderungen

Löschen / DELETE

DELETE auf die URI eines Member Entry löscht diesen

Löschen eines Media Link Eintrags sollte auch die zugehörige Media Resource löschen

Methoden HTTP Methode URI Returns CREATE POST Collection URI Member Representation 201 Created Location: Member URI READ GET Member URI 200 Ok Member Representation UPDATE PUT Member URI Member Representation 200 Ok DELETE DELETE Member URI 200 Ok

Pagination

Zu große Collections kann der Server teilen
Navigation via rel-Attribute

„next“, „previous“, „first“, „last“

< feed xmlns = "http://www.w3.org/2005/Atom" > < link rel = "first" href = "http://example.org/entries/" /> < link rel = "previous" href = "http://example.org/entries/2" /> < link rel = "next" href = "http://example.org/entries/4" /> < link rel = "last" href = "http://example.org/entries/10" />  </ feed >

Category Documents

In einer Collection erlaubte Kategorien

fixed = Liste der Kategorien unveränderbar

Mime Type = „application/atomcat+xml“

<? xml version = "1.0" ?> < app:categories xmlns:app = "http://www.w3.org/2007/app" xmlns:atom = "http://www.w3.org/2005/Atom" fixed = "yes" scheme = "http://example.com/cats/big3" > < atom:category term = "animal" /> < atom:category term = "vegetable" /> < atom:category term = "mineral" /> </ app:categories >