mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
106 lines
2.5 KiB
Markdown
106 lines
2.5 KiB
Markdown
# community-server
|
|
|
|
Implementation of the Solid server.
|
|
|
|
The architecture is based on the description [here](https://github.com/RubenVerborgh/solid-server-architecture).
|
|
We follow the Inrupt [coding standards](https://github.com/inrupt/public-documentation/blob/master/coding-conventions/javascript-coding-standards.md) where feasible.
|
|
An initial dummy implementation with some examples can be found [here](https://github.com/RubenVerborgh/solid-server-ts).
|
|
|
|
## Running locally
|
|
|
|
```
|
|
npm ci
|
|
npm start
|
|
```
|
|
|
|
## Interacting with the server
|
|
|
|
The server supports low-level interaction via HTTP methods,
|
|
such as `GET`, `PUT`, `HEAD`, ...
|
|
|
|
Below, we provide several examples on how to interact with the server using `curl`.
|
|
|
|
### `PUT`: Creating resources for a given URL
|
|
|
|
Create a plain text file:
|
|
```bash
|
|
$ curl -X PUT -H "Content-Type: text/plain" \
|
|
-d "abc" \
|
|
http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
Create a turtle file:
|
|
```bash
|
|
$ curl -X PUT -H "Content-Type: text/turtle" \
|
|
-d "<ex:s> <ex:p> <ex:o>." \
|
|
http://localhost:3000/myfile.ttl
|
|
```
|
|
|
|
### `POST`: Creating resources at a generated URL
|
|
|
|
Create a plain text file:
|
|
```bash
|
|
$ curl -X POST -H "Content-Type: text/plain" \
|
|
-d "abc" \
|
|
http://localhost:3000/
|
|
```
|
|
|
|
Create a turtle file:
|
|
```bash
|
|
$ curl -X POST -H "Content-Type: text/turtle" \
|
|
-d "<ex:s> <ex:p> <ex:o>." \
|
|
http://localhost:3000/
|
|
```
|
|
|
|
The response's `Location` header will contain the URL of the created resource.
|
|
|
|
### `GET`: Retrieving resources
|
|
|
|
Retrieve a plain text file:
|
|
```bash
|
|
$ curl -H "Accept: text/plain" \
|
|
http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
Retrieve a turtle file:
|
|
```bash
|
|
$ curl -H "Accept: text/turtle" \
|
|
http://localhost:3000/myfile.ttl
|
|
```
|
|
|
|
Retrieve a turtle file in a different serialization:
|
|
```bash
|
|
$ curl -H "Accept: application/ld+json" \
|
|
http://localhost:3000/myfile.ttl
|
|
```
|
|
|
|
### `DELETE`: Deleting resources
|
|
|
|
```bash
|
|
$ curl -X DELETE http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
### `PATCH`: Modifying resources
|
|
|
|
Currently, only patches over RDF resources are supported using [SPARQL Update](https://www.w3.org/TR/sparql11-update/)
|
|
queries without `WHERE` clause.
|
|
|
|
```bash
|
|
$ curl -X PATCH -H "Content-Type: application/sparql-update" \
|
|
-d "INSERT DATA { <ex:s2> <ex:p2> <ex:o2> }" \
|
|
http://localhost:3000/myfile.ttl
|
|
```
|
|
|
|
### `HEAD`: Retrieve resources headers
|
|
|
|
```bash
|
|
$ curl -I -H "Accept: text/plain" \
|
|
http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
### `OPTIONS`: Retrieve resources communication options
|
|
|
|
```bash
|
|
$ curl -X OPTIONS -i http://localhost:3000/myfile.txt
|
|
```
|