Add Data responses and TypedDataResponse

[aydenp]

In some cases, you may want to just return raw Data as a Response. Before this commit, you might have had to make your own ResponseEncodable type that just provides the data, which seems a bit much for such a simple function.

Say we have this super important data that we need to respond with:

let data = "Hello!".data(using: .utf8)!

At it's simplest, this new functionality allows you to respond with a Data object by simply returning it:

router.get("hello") { req in
    return data
}

However, sometimes, you might want to return this data with a custom content type. In this case, you can simply get a TypedDataResponse from a new Data extension, and return it, instead of the Data:

router.get("hello") { req in
    return data.response(type: .html)
}

As an aside, TypedDataResponse is also used under the hood if you just return Data on it's own, with a content type of MediaType.any.

Checklist

• Circle CI is passing (code compiles and passes tests).
• There are no breaking changes to public API.
• New test cases have been added where appropriate.
• All new code has been commented with doc blocks ///.

[tanner0101]

Just some gardening comments. Looks great I love the idea.

[tanner0101]

Just some gardening comments. Looks great I love the idea.

[tanner0101]

We should make this type private and just publicize ResponseEncodable.

[aydenp]

ResponseEncodable is already public, but I agree that this type should be private. An earlier iteration of it didn't have the Data extension for types, so I'd forgotten to make it private.

[tanner0101]

Here we should be able to just return ResponseEncodable.

[tanner0101]

should be a newline above this comment.

[tanner0101]

couple gardening notes here:

• vapor uses /// format comments
• - parameters should be listed as a separate bulleted list, see any of the other doc blocks for an example
• methods expected to be used directly by the end user should have a small example code section if possible! that really helps people figure out how to use it.

[tanner0101]

I will fix the test errors on a different branch. thanks!

[tanner0101]

I will fix the test errors on a different branch. thanks!

[penny-coin]

Hey @aydenp, you just merged a pull request, have a coin!

You now have 1 coins.

[tanner0101]

Ended on something slightly different, but I think it better matches the other available APIs which will make things more intuitive.

// default to plaintext
router.get("hello") { req in
    return req.makeResponse("Hello!")
}

// specify content type
router.get("hello-html") { req in
    return req.makeResponse("Hey!", as: .html)
}

// and of course, what we had previously
router.get("hello-json") { req in
    let res = req.makeResponse()
    try res.content.encode(["hello": "world"], as: .json)
    return res
}

[tanner0101]

Worth noting that both String and Data conform to HTTPBodyLosslessRepresentable. Any other types that conform can also be used with this new method.

[nullpixel]

Do your changes let you just return Data, like return someData?

If they don't, then I'd suggest this is less initiative.

[tanner0101]

@nullpixel what Content-Type would Data use? There wasn't an obvious best choice there which is why I omitted that part.

[nullpixel]

Well, .any makes the most sense, since, well, it can be anything. But you do have a valid point.