| Auszug |
|---|
|
Nuclos REST guidelines: GET, POST, PUT, DELETE, idempotent, path, PathParam, RVO, service implementation. |
Language: Deutsch · English
Guidelines for REST service implementations
Conventions for your own REST services – HTTP verbs, path design and a code example.
| Status |
|---|
| colour | Green |
|---|
| title | Updated: Jul 2026 |
|---|
|
| Status |
|---|
| colour | Grey |
|---|
| title | applies to Nuclos 4.2026.x |
|---|
|
Guidelines for implementing your own REST services in Nuclos.
1. HTTP verbs strictly per REST standard
| Verb | Meaning |
|---|
| GET | fetch data – no change in the DB. |
| POST | create an object in the DB. |
| PUT | modify an object (idempotent; a second PUT creates no new record). |
| DELETE | delete one or more objects. |
2. Self-describing, object-oriented paths
| Codeblock |
|---|
|
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
Related pages
RESTful service
REST service.
Open →
