RESTful Design for Internet of Things Systems
draft-irtf-t2trg-rest-iot-04

• Status
• IESG evaluation record
• IESG writeups
• Email expansions
• History

• Versions
• 00
• 01
• 02
• 03
• 04

Network Working Group                                         A. Keranen
Internet-Draft                                                  Ericsson
Intended status: Informational                               M. Kovatsch
Expires: January 9, 2020                                      Siemens AG
                                                               K. Hartke
                                                                Ericsson
                                                           July 08, 2019

             RESTful Design for Internet of Things Systems
                      draft-irtf-t2trg-rest-iot-04

Abstract

   This document gives guidance for designing Internet of Things (IoT)
   systems that follow the principles of the Representational State
   Transfer (REST) architectural style.  This document is a product of
   the IRTF Thing-to-Thing Research Group (T2TRG).

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 https://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 January 9, 2020.

Copyright Notice

   Copyright (c) 2019 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
   (https://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 January 9, 2020                [Page 1]
Internet-Draft       RESTful Design for IoT Systems            July 2019

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Basics  . . . . . . . . . . . . . . . . . . . . . . . . . . .   7
     3.1.  Architecture  . . . . . . . . . . . . . . . . . . . . . .   7
     3.2.  System design . . . . . . . . . . . . . . . . . . . . . .   9
     3.3.  Uniform Resource Identifiers (URIs) . . . . . . . . . . .  10
     3.4.  Representations . . . . . . . . . . . . . . . . . . . . .  11
     3.5.  HTTP/CoAP Methods . . . . . . . . . . . . . . . . . . . .  12
       3.5.1.  GET . . . . . . . . . . . . . . . . . . . . . . . . .  12
       3.5.2.  POST  . . . . . . . . . . . . . . . . . . . . . . . .  13
       3.5.3.  PUT . . . . . . . . . . . . . . . . . . . . . . . . .  13
       3.5.4.  DELETE  . . . . . . . . . . . . . . . . . . . . . . .  13
       3.5.5.  FETCH . . . . . . . . . . . . . . . . . . . . . . . .  14
       3.5.6.  PATCH . . . . . . . . . . . . . . . . . . . . . . . .  14
     3.6.  HTTP/CoAP Status/Response Codes . . . . . . . . . . . . .  14
   4.  REST Constraints  . . . . . . . . . . . . . . . . . . . . . .  15
     4.1.  Client-Server . . . . . . . . . . . . . . . . . . . . . .  15
     4.2.  Stateless . . . . . . . . . . . . . . . . . . . . . . . .  16
     4.3.  Cache . . . . . . . . . . . . . . . . . . . . . . . . . .  16
     4.4.  Uniform Interface . . . . . . . . . . . . . . . . . . . .  17
     4.5.  Layered System  . . . . . . . . . . . . . . . . . . . . .  18
     4.6.  Code-on-Demand  . . . . . . . . . . . . . . . . . . . . .  18
   5.  Hypermedia-driven Applications  . . . . . . . . . . . . . . .  19
     5.1.  Motivation  . . . . . . . . . . . . . . . . . . . . . . .  19
     5.2.  Knowledge . . . . . . . . . . . . . . . . . . . . . . . .  20
     5.3.  Interaction . . . . . . . . . . . . . . . . . . . . . . .  20
     5.4.  Hypermedia-driven Design Guidance . . . . . . . . . . . .  21
   6.  Design Patterns . . . . . . . . . . . . . . . . . . . . . . .  21
     6.1.  Collections . . . . . . . . . . . . . . . . . . . . . . .  21
     6.2.  Calling a Procedure . . . . . . . . . . . . . . . . . . .  22
       6.2.1.  Instantly Returning Procedures  . . . . . . . . . . .  22
       6.2.2.  Long-running Procedures . . . . . . . . . . . . . . .  22
       6.2.3.  Conversion  . . . . . . . . . . . . . . . . . . . . .  23
       6.2.4.  Events as State . . . . . . . . . . . . . . . . . . .  23
     6.3.  Server Push . . . . . . . . . . . . . . . . . . . . . . .  24