know-your-http-well

HTTP headers, media-types, methods, relations and status codes, all summarized and linking to their specification.

npm install know-your-http-well
4 downloads in the last day
24 downloads in the last week
58 downloads in the last month

KNOW YOUR HTTP * WELL

HTTP headers, media types, methods, relations and status codes, all summarized and linking to their specification.

This project is used by HyperREST bin at bin.hyperrest.com .

Table of Contents

How to convert to other formats

Packages

Emacs

(require 'know-your-http-well)
;; M-x http-header ;; content-type
;; M-x http-method ;; post | POST
;; M-x http-relation ;; describedby
;; M-x http-status-code ;; 500
;; M-x http-status-code ;; not_found | NOT_FOUND

JavaScript

var httpWell = require('know-your-http-well'),
    statusWell = httpWell.statusPhrasesToCodes,
    phraseWell = httpWell.statusCodesToPhrases;

// on the server side
res.statusCode = statusWell.NOT_FOUND

// on the client side
if (res.statusCode !== statusWell.OK) {
    // Log "Request returned 404 Not Found"
    log('Request returned ' + res.statusCode + ' ' + phraseWell[res.statusCode]);
}

JSON

Just take a look at ./json/*.json.

Dash on Mac OSX and Zeal on Windows/Linux

If you want know-your-http-well to be included in the common list of docsets, just tweet to @kapeli for a +1.

Meanwhile, Preferences -> Docsets -> + and using https://raw.github.com/for-GET/know-your-http-well/master/docset/know-your-http-well.xml should do it.

License

Unlicense.

npm loves you