Returning XML in response from Loopback Remote Method

Question

I am using the Loopback Connector REST (1.9.0) and have a remote method that returns XML:

   Foo.remoteMethod
   (  
      \"getXml\",
      {
         accepts:          


        

Answer 1

You need to set toXML in your response object (more on that in a bit). First, set the return type to 'object' as shown below:

Foo.remoteMethod
(  
  "getXml",
  {
     accepts: [            
        {arg: 'id', type: 'string', required: true }
     ],
     http: {path: '/:id/content', "verb": 'get'},
     returns: {"type": "object", root:true},
     rest: {"after": setContentType("text/xml") }         
  }
)

Next, you will need to return a JSON object with toXML as the only property. toXML should be a function that returns a string representation of your XML. If you set the Accept header to "text/xml" then the response should be XML. See below:

Foo.getXml = function(cb) {
  cb(null, {
    toXML: function() {
      return '<something></something>';
    }
  });
};

You still need to enable XML in config.json because it's disabled by default:

"remoting": {
  "rest": {
    "normalizeHttpPath": false,
    "xml": true
  }
}

See https://github.com/strongloop/strong-remoting/blob/4b74a612d3c969d15e3dcc4a6d978aa0514cd9e6/lib/http-context.js#L393 for more info on how this works under the hood.

Answer 2

I recently ran into this with trying to create a dynamic response for Twilio voice calling in Loopback 3.x. In the model.remoteMethod call, explicitly specify the return type and content type as follows:

model.remoteMethod(
    "voiceResponse", {
        accepts: [{
            arg: 'envelopeId',
            type: 'number',
            required: true
        }],
        http: {
            path: '/speak/:envelopeId',
            "verb": 'post'
        },
        returns: [{
            arg: 'body',
            type: 'file',
            root: true
        }, {
            arg: 'Content-Type',
            type: 'string',
            http: {
                target: 'header'
            }
        }],

    }
)

Have your method return both the xml and the content type via the callback function. Note that the first argument in the callback is to return an error if one exists:

model.voiceResponse = function(messageEnvelopeId, callback) {

    app.models.messageEnvelope.findById(messageEnvelopeId, {
        include: ['messages']
    }).then(function(res) {
        let voiceResponse = new VoiceResponse();
        voiceResponse.say({
                voice: 'woman',
                language: 'en'
            },
            "This is a notification alert from your grow system. " + res.toJSON().messages.message
        )

        callback(null,
            voiceResponse.toString(), // returns xml document as a string
            'text/xml'
        );
    });
}