Nuclos REST guidelines: GET, POST, PUT, DELETE, idempotent, path, PathParam, RVO, service implementation.

globe with meridians Language: Deutsch · English

open book Guidelines for REST service implementations

Conventions for your own REST services – HTTP verbs, path design and a code example.

Auf dieser Seite

Guidelines for implementing your own REST services in Nuclos.

1. HTTP verbs strictly per REST standard

VerbMeaning
GETfetch data – no change in the DB.
POSTcreate an object in the DB.
PUTmodify an object (idempotent; a second PUT creates no new record).
DELETEdelete one or more objects.

2. Self-describing, object-oriented paths

POST   /tree
PUT    /tree/{treeid}
DELETE /tree/{treeid}/branch/{branchid}

3. Avoid unnecessary path parts

Especially at the start, avoid superfluous segments (e.g. not /neudazu/botanik/heinzmueller/pflanzen/tree/).

4. Example: user management

POST /tree

Related pages

gear RESTful service


REST service.

Öffnen →