node-red/nodes/io/21-httpin.html

<!--
  Copyright 2013 IBM Corp.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
-->

<script type="text/x-red" data-template-name="http in">
    <div class="form-row">
        <label for="node-input-method"><i class="icon-tasks"></i> Method</label>
        <select type="text" id="node-input-method" style="width: 150px;">
        <option value="get">GET</option>
        <option value="post">POST</option>
        <option value="put">PUT</option>
        <option value="delete">DELETE</option>
        </select>
    </div>
    <div class="form-row">
        <label for="node-input-topic"><i class="icon-globe"></i> url</label>
        <input type="text" id="node-input-url" placeholder="/url">
    </div>
    <div class="form-row">
        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
        <input type="text" id="node-input-name" placeholder="Name">
    </div>
</script>

<script type="text/x-red" data-help-name="http in">
	<p>Provides an input node for http requests, allowing the creation of simple web services.</p>
	<p>The resulting message has the following properties:
	    <ul>
	        <li>msg.req : <a href="http://expressjs.com/api.html#req">http request</a></li>
	        <li>msg.res : <a href="http://expressjs.com/api.html#res">http response</a></li>
	    </ul>
	</p>
	<p>For POST/PUT requests, the body is available under <code>msg.req.body</code>. This
	   uses the <a href="http://expressjs.com/api.html#bodyParser">Express bodyParser middleware</a> to parse the content to a JSON object.
    </p>
	<p>
	   By default, this expects the body of the request to be url encoded:
	   <pre>foo=bar&amp;this=that</pre>
    </p>
	<p>
	   To send JSON encoded data to the node, the content-type header of the request must be set to
	   <code>application/json</code>.
	</p>
	<p>
	   <b>Note: </b>This node does not send any response to the http request. This should be done with
	   a subsequent HTTP Response node, or Function node.
	   In the case of a Function node, the <a href="http://expressjs.com/api.html#res">Express response documentation</a>
	   describes how this should be done. For example:
	   <pre>msg.res.send(200, 'Thanks for the request ');<br/>return msg;</pre>
    </p>

</script>

<script type="text/javascript">
    RED.nodes.registerType('http in',{
        category: 'input',
        color:"rgb(231, 231, 174)",
        defaults: {
            name: {value:""},
            url: {value:"",required:true},
            method: {value:"get",required:true}
        },
        inputs:0,
        outputs:1,
        icon: "white-globe.png",
        label: function() {
            return this.name||"["+this.method+"] "+this.url;
        },
        labelStyle: function() {
            return this.name?"node_label_italic":"";
        }
    });
</script>

<script type="text/x-red" data-template-name="http response">
    <div class="form-tips">The messages sent to this node must originate from an HTTP input node</div>
</script>

<script type="text/x-red" data-help-name="http response">
	<p>Provides an response node for http requests received from an http input node.</p>
	<ul>
	    <li><code>payload</code> is sent as the body of the reponse</li>
	    <li><code>rc</code>, if set, is used as the response code (default: 200)</li>
	    <li><code>headers</code>, if set, should be an object containing field/value
	    pairs to be added as response headers.</li>
	</ul>
</script>

<script type="text/javascript">
    RED.nodes.registerType('http response',{
        category: 'output',
        color:"rgb(231, 231, 174)",
        defaults: {},
        inputs:1,
        outputs:0,
        align: "right",
        icon: "white-globe.png",
        label: function() {
            return "http"
        },
        labelStyle: function() {
            return "";
        }
    });
</script>