From 5caccfec0ae5334f2bf9b5d251911d2cc5a71338 Mon Sep 17 00:00:00 2001 From: Hannes Ebner Date: Thu, 31 Mar 2022 18:02:43 +0200 Subject: [PATCH] Moving documentation further up --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index cef282f..511a073 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ ## Boilerplate -As you could see as the result of 5. above, the boilerplate is a very basic, but fully functional implementation of a REST API. +As you could see as the result of 5. above, the boilerplate is a very basic, but fully functional implementation of a REST API. The boilerplate is built using the [Restlet framework](https://restlet.talend.com/). You may find its documentation of the [resource architecture](https://restlet.talend.com/documentation/user-guide/2.4/core/resource/overview) and the [server tutorial](https://restlet.talend.com/documentation/user-guide/2.4/introduction/first-steps/first-application) useful. There are only two REST resources: a status resource that attaches to `/status` and a default resource that responds at `/`. @@ -22,8 +22,6 @@ Implementing a new resource involves creating a new class (see `StatusResource.j 1. Implement a new resource `/echo` that responds with the request body when posting (HTTP POST) to it; it should simply mirror the request back as response. 2. Add content negotiation to the echo resource and convert the payload: if the request is made with MIME type `text/csv` (i.e., `Content-Type: text/csv`), and the response is expected to be delivered in `text/html` (i.e., `Accept: text/html`), then convert from CSV to a simple HTML table. Very basic handling of the CSV payload (use the snippet from the next section) is sufficient, you don't need to use third party libraries to handle advanced CSVs with apostrophes, line breaks, etc.. -The boilerplate is built using the [Restlet framework](https://restlet.talend.com/). You may find its documentation of the [resource architecture](https://restlet.talend.com/documentation/user-guide/2.4/core/resource/overview) and the [server tutorial](https://restlet.talend.com/documentation/user-guide/2.4/introduction/first-steps/first-application) useful. - Bonus for the Linked Data experienced: 3. Add support for the output format `text/turtle` (the [RDF Turtle serialization format](https://www.w3.org/TR/turtle/)) to the echo resource. Use appropriate properties from the [Dublin Core Terms metadata specification](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/).