Building Protocols with HTTP
draft-ietf-httpbis-bcp56bis-06

Document Type Active Internet-Draft (httpbis WG)
Last updated 2018-07-01
Stream IETF
Intended RFC status Best Current Practice
Formats plain text xml pdf html bibtex
Stream WG state WG Document
Document shepherd Patrick McManus
IESG IESG state I-D Exists
Consensus Boilerplate Yes
Telechat date
Responsible AD (None)
Send notices to Patrick McManus <mcmanus@ducksong.com>
HTTP                                                       M. Nottingham
Internet-Draft                                              July 1, 2018
Obsoletes: 3205 (if approved)
Intended status: Best Current Practice
Expires: January 2, 2019

                      Building Protocols with HTTP
                     draft-ietf-httpbis-bcp56bis-06

Abstract

   HTTP is often used as a substrate for other application protocols
   (a.k.a.  HTTP-based APIs).  This document specifies best practices
   for these protocols' use of HTTP.

Note to Readers

   Discussion of this draft takes place on the HTTP working group
   mailing list (ietf-http-wg@w3.org), which is archived at
   https://lists.w3.org/Archives/Public/ietf-http-wg/ [1].

   Working Group information can be found at http://httpwg.github.io/
   [2]; source code and issues list for this draft can be found at
   https://github.com/httpwg/http-extensions/labels/bcp56bis [3].

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 2, 2019.

Copyright Notice

   Copyright (c) 2018 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Nottingham               Expires January 2, 2019                [Page 1]
Internet-Draft        Building Protocols with HTTP             July 2018

   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
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Notational Conventions  . . . . . . . . . . . . . . . . .   4
   2.  Is HTTP Being Used? . . . . . . . . . . . . . . . . . . . . .   4
   3.  What's Important About HTTP . . . . . . . . . . . . . . . . .   5
     3.1.  Generic Semantics . . . . . . . . . . . . . . . . . . . .   5
     3.2.  Links . . . . . . . . . . . . . . . . . . . . . . . . . .   6
     3.3.  Rich Functionality  . . . . . . . . . . . . . . . . . . .   7
   4.  Best Practices for Using HTTP . . . . . . . . . . . . . . . .   7
     4.1.  Specifying the Use of HTTP  . . . . . . . . . . . . . . .   8
     4.2.  Defining HTTP Resources . . . . . . . . . . . . . . . . .   8
     4.3.  Specifying Client Behaviours  . . . . . . . . . . . . . .   9
     4.4.  HTTP URLs . . . . . . . . . . . . . . . . . . . . . . . .  10
       4.4.1.  Initial URL Discovery . . . . . . . . . . . . . . . .  11
       4.4.2.  URL Schemes . . . . . . . . . . . . . . . . . . . . .  11
       4.4.3.  Transport Ports . . . . . . . . . . . . . . . . . . .  12
     4.5.  HTTP Methods  . . . . . . . . . . . . . . . . . . . . . .  12
       4.5.1.  GET . . . . . . . . . . . . . . . . . . . . . . . . .  13
       4.5.2.  OPTIONS . . . . . . . . . . . . . . . . . . . . . . .  14
     4.6.  HTTP Status Codes . . . . . . . . . . . . . . . . . . . .  14
       4.6.1.  Redirection . . . . . . . . . . . . . . . . . . . . .  16
     4.7.  HTTP Header Fields  . . . . . . . . . . . . . . . . . . .  17
     4.8.  Defining Message Payloads . . . . . . . . . . . . . . . .  18
     4.9.  HTTP Caching  . . . . . . . . . . . . . . . . . . . . . .  18
     4.10. Application State . . . . . . . . . . . . . . . . . . . .  20
     4.11. Client Authentication . . . . . . . . . . . . . . . . . .  20
     4.12. Co-Existing with Web Browsing . . . . . . . . . . . . . .  21
     4.13. Application Boundaries  . . . . . . . . . . . . . . . . .  22
     4.14. Server Push . . . . . . . . . . . . . . . . . . . . . . .  23
     4.15. Versioning and Evolution  . . . . . . . . . . . . . . . .  24
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  24
   6.  Security Considerations . . . . . . . . . . . . . . . . . . .  24
     6.1.  Privacy Considerations  . . . . . . . . . . . . . . . . .  25
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  26
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  26
Show full document text