README.md 1.38 KB
Newer Older
joern@existsolutions.com's avatar
joern@existsolutions.com committed
1 2 3 4 5
# Web Annotation Service

aims to be an implementation of [Web Annotation Protocol](http://w3c.github.io/web-annotation/protocol/wd/) running as
a service app on eXist-db.

6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
## Requirements

* eXist-db 5.x

## Building

WAP is an eXist-db application that needs to be deployed installed
via the eXist-db Packagemanager.

For building Apache Ant > Ver. 1.8 needs to be installed.

To build the application execute this on the command line:

```
ant
```

This creates the application archive in a folder named `build`. 


joern@existsolutions.com's avatar
joern@existsolutions.com committed
26 27 28 29 30 31 32
## Approach

Implementing the full spec is a huge effort as always with W3C specs. We'll drive the development
incrementally using our concrete requirements to steer priorities.

Beyond that the effort will target the feature marked as MUST und just eventually consider SHOULD or SHALL features.

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
## read

   curl http://localhost:8080/exist/apps/wap/annotations/a1

## list

   curl http://localhost:8080/exist/apps/wap/annotations/

read next page

   curl http://localhost:8080/exist/apps/wap/annotations/?page=1


Not implemented yet, list by document

   curl http://localhost:8080/exist/apps/wap/annotations/?document-id=1

## add

   curl -X POST http://localhost:8080/exist/apps/wap/annotations/ -d @doc/single.json -H "Content-Type: multipart/mixed"

## add batch

    curl -X POST http://localhost:8080/exist/apps/wap/annotations/ -d @doc/data.json -H "Content-Type: multipart/mixed"