How To Upload Images, Store Them and Serve Them With Vapor 4 | by Fernando Moya de Rivas | Apr, 2022

For the previous few weeks, I’ve been researching and sharing articles about Vapor 4 and its capabilities. I began with a easy mission construction and API definition:

and constructed it up from that to clarify DB Mannequin relationships:

On this article, we’ll develop on the unique mission and can discover ways to add photos, retailer them and serve them. Lastly, I’ll point out another attention-grabbing options I didn’t get to cowl in my analysis. If you happen to get misplaced, you possibly can all the time verify the ultimate mission here:

Our purpose right here is to create a brand new endpoint /todo-lists/<id>/upload-image that may settle for a multipart type that with the picture. Let’s first create the endpoint. Go to TodoListViewController.boot(routes:) technique and create a brand new route:

func boot(routes: RoutesBuilder) throws 
let singleListRoutes = ...
singleListRoutes.get("upload-image", use: uploadImage)
non-public func uploadImage(req: Request) throws -> EventLoopFuture<Response>

Now, all we have to do is extract the picture information, however how will we do that? And as soon as we’ve got the file, how will we retailer it and serve it?

To take action, we will make use of FileMiddleware . A Middleware is only a class that allows you to course of an incoming request earlier than it reached the route handler. You possibly can consider it as a Proxy. You possibly can create your personal, say, to have all responses add a sure header frequent to all responses:

For our functions, Vapor ships with FileMiddleware which helps you to serve property to purchasers from a public folder. We can be utilizing the workingDirectory for simplicity, however ideally, you’d serve your information from a particular Public listing.

Much like databases or migrations, any sort of configuration must be completed within the configure(_:) operate inside configure.swift :

app.middleware.use(FileMiddleware(publicDirectory: app.listing.workingDirectory))

In addition to, we have to improve the defaultMaxBodySize for requests:

app.routes.defaultMaxBodySize = "10mb"

In any other case, you’ll get a Payload Too Massive error. Now all we have to do is decode the picture from the request and retailer it on the server. Let’s do that:

// 1.
let file = strive req.content material.decode(File.self)
let path = + file.filename
// 2.
return req.fileio
.writeFile(file.information, at: file.filename)
// 3.
.rework(to: Response(standing: .accepted))

Let’s break it down:

  • First, we decode a File from the response. Vapor ships with this utility. In addition to, we type the trail the place the file can be saved.
  • Subsequent, we make use fileIO to jot down save the file right into a path in our server
  • Lastly, we return an accepted response

Sufficient speaking, lets strive it out? I downloaded a sample image which I can then use for my TodoList :

$ curl localhost:8080/v1/todo-lists 
-H "Content material-Sort:software/json"
--data " "identify": "Foo" "
$ curl localhost:8080/v1/todo-lists/F65B591A-AFE9-4848-AFCB-4FC606002596/upload-image
-F filename=instance.webp
-F information=@/Customers/fermoya/Desktop/instance.webp
-H "Content material-Sort:multipart/form-data"

Good! However the place’s my picture now? Nicely, the file path we used was /<working_directory>/<file_name> . That signifies that the file can be obtainable underneath localhost:8080/<file_name> :

Nonetheless, the picture just isn’t linked to any TodoList simply but! We’re in reality simply storing the picture however it should get misplaced except continued into our TodoList mannequin.

In the meanwhile, TodoList isn’t prepared to carry a picture simply but. We have to add a brand new area to the mannequin. That is simple sufficient in the event you keep in mind from earlier articles:

Discover that we’re merely updating an current desk. This isn’t actually essential for our instance as we’re utilizing an in-memory database, however you’d want it for an actual App. Ensure you replace the desk solely after you create it in CreateTodoListMigration .

Now, we’d solely must replace the /upload-image implementation:

What’s new right here?

  • First, we’re fetching the record and aborting if notFound
  • Secondly, replace the record after saving the picture. That is considerably associated to an train we left for the reader in Half 1
  • Return the up to date record as a response

We’re completed! If you happen to do that time, you need to get one thing like:

$ curl localhost:8080/v1/todo-lists 
-H "Content material-Sort:software/json"
--data " "identify": "Foo" "
"id":"F65B591A-AFE9-4848-AFCB-4FC606002596","identify":"Foo", "imageURL": null
$ curl localhost:8080/v1/todo-lists/F65B591A-AFE9-4848-AFCB-4FC606002596/upload-image
-F filename=instance.webp
-F information=@/Customers/fermoya/Desktop/instance.webp
-H "Content material-Sort:multipart/form-data" | jq

"id": "F65B591A-AFE9-4848-AFCB-4FC606002596",
"identify": "Foo",
"imageURL": ""

That is neat, though there’s an enormous flaw on this implementation: we’re not likely correctly dealing with the photographs, and it’d be pretty easy to overwrite the modifications if, say, a picture with the identical identify is uploaded for a very totally different record.

One option to remedy this may be to disregard the filename area within the multipart/form-data and compose the identify like MD5_Hash(#"<uuid>.<timestamp>") however we’ll depart this as an train for the reader.

There are such a lot of options we haven’t lined on this collection as a result of lack of time, however these are value mentioning:

  • Leaf: We centered on the backend facet of Vapor however the framework ships with Leaf which helps you flip Swift into dynamic HTML. This can allow you to create the frontend facet of your net app.
  • Logging: Each Request and Utility include a logger property with a number of hint ranges: INFO , ERROR , DEBUG … For example, req.logger.debug("Updating record with id (id)")
  • Superior routing: Some issues that we didn’t cowl are:
    Redirections: as an example, an endpoint has been renamed and also you want to merely reroute to the brand new one.
    Catchalls: use ** as dynamic routes to match a number of parts, i.e. /foo/** responds to /foo/bar , /foo/bar/abc , … You possibly can then use getCatchall to retrieve them as an array of String
    View all routes: you possibly can print all registered routes by print(app.routes.all)
  • HTTP Client: who mentioned you received’t must make an HTTP request from one among your endpoints? Vapor ships with an easy-to-use HTTP shopper.
  • Websockets: two-way communications between a shopper and your server, say, for a chat app as an example.
  • Queues: very helpful in case your endpoint triggers some heavy operations. You possibly can reply rapidly to the shopper and schedule a Job . A quite common instance can be a reset-password endpoint the place an electronic mail must be despatched.
  • Services: they turn out to be useful to reuse code in a number of endpoints or use third-party libraries.
  • APNS: Developed in Swift, almost certainly for somebody who’s labored with iOS/macOS, Vapor makes it simple to present help to Apple notifications.

More Posts