RESTful Design for Internet of Things Systems
draft-keranen-t2trg-rest-iot-05
|
| Document |
Type |
|
Active Internet-Draft (individual)
|
|
Last updated |
|
2017-09-14
|
|
Stream |
|
(None)
|
|
Intended RFC status |
|
(None)
|
|
Formats |
|
plain text
xml
pdf
html
bibtex
|
| Stream |
Stream state |
|
(No stream defined) |
|
Consensus Boilerplate |
|
Unknown
|
|
RFC Editor Note |
|
(None)
|
| IESG |
IESG state |
|
I-D Exists
|
|
Telechat date |
|
|
|
Responsible AD |
|
(None)
|
|
Send notices to |
|
(None)
|
Network Working Group A. Keranen
Internet-Draft Ericsson
Intended status: Informational M. Kovatsch
Expires: March 18, 2018 ETH Zurich
K. Hartke
Universitaet Bremen TZI
September 14, 2017
RESTful Design for Internet of Things Systems
draft-keranen-t2trg-rest-iot-05
Abstract
This document gives guidance for designing Internet of Things (IoT)
systems that follow the principles of the Representational State
Transfer (REST) architectural style.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on March 18, 2018.
Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
Keranen, et al. Expires March 18, 2018 [Page 1]
Internet-Draft RESTful Design for IoT Systems September 2017
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . . 3
3. Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.1. Architecture . . . . . . . . . . . . . . . . . . . . . . 6
3.2. System design . . . . . . . . . . . . . . . . . . . . . . 8
3.3. Uniform Resource Identifiers (URIs) . . . . . . . . . . . 9
3.4. Representations . . . . . . . . . . . . . . . . . . . . . 10
3.5. HTTP/CoAP Methods . . . . . . . . . . . . . . . . . . . . 10
3.5.1. GET . . . . . . . . . . . . . . . . . . . . . . . . . 11
3.5.2. POST . . . . . . . . . . . . . . . . . . . . . . . . 11
3.5.3. PUT . . . . . . . . . . . . . . . . . . . . . . . . . 12
3.5.4. DELETE . . . . . . . . . . . . . . . . . . . . . . . 12
3.6. HTTP/CoAP Status/Response Codes . . . . . . . . . . . . . 12
4. REST Constraints . . . . . . . . . . . . . . . . . . . . . . 13
4.1. Client-Server . . . . . . . . . . . . . . . . . . . . . . 13
4.2. Stateless . . . . . . . . . . . . . . . . . . . . . . . . 14
4.3. Cache . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.4. Uniform Interface . . . . . . . . . . . . . . . . . . . . 14
4.5. Layered System . . . . . . . . . . . . . . . . . . . . . 15
4.6. Code-on-Demand . . . . . . . . . . . . . . . . . . . . . 15
5. Hypermedia-driven Applications . . . . . . . . . . . . . . . 16
5.1. Motivation . . . . . . . . . . . . . . . . . . . . . . . 16
5.2. Knowledge . . . . . . . . . . . . . . . . . . . . . . . . 17
5.3. Interaction . . . . . . . . . . . . . . . . . . . . . . . 18
6. Design Patterns . . . . . . . . . . . . . . . . . . . . . . . 18
6.1. Collections . . . . . . . . . . . . . . . . . . . . . . . 18
6.2. Calling a Procedure . . . . . . . . . . . . . . . . . . . 19
6.2.1. Instantly Returning Procedures . . . . . . . . . . . 19
6.2.2. Long-running Procedures . . . . . . . . . . . . . . . 19
6.2.3. Conversion . . . . . . . . . . . . . . . . . . . . . 20
6.2.4. Events as State . . . . . . . . . . . . . . . . . . . 20
6.3. Server Push . . . . . . . . . . . . . . . . . . . . . . . 21
7. Security Considerations . . . . . . . . . . . . . . . . . . . 22
8. Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . 23
Show full document text