{"id":9175,"date":"2022-02-21T23:29:53","date_gmt":"2022-02-21T23:29:53","guid":{"rendered":"http:\/\/putridparrot.com\/blog\/?p=9175"},"modified":"2022-02-21T23:29:53","modified_gmt":"2022-02-21T23:29:53","slug":"getting-started-with-vapor","status":"publish","type":"post","link":"https:\/\/putridparrot.com\/blog\/getting-started-with-vapor\/","title":{"rendered":"Getting started with Vapor"},"content":{"rendered":"

Vapor<\/a> is a web application framework written in Swift.<\/p>\n

Installing on Linux<\/strong><\/p>\n

As I’m more likely to be using a Linux server for my web application, that’s what we’ll use for this post. So following the Install on Linux<\/a> instructione, I went the route of installing the toolbox for the toolbox repo (instructions recreated below)<\/p>\n

\r\ngit clone https:\/\/github.com\/vapor\/toolbox.git\r\ncd toolbox\r\ngit checkout <desired version>\r\nmake install\r\n<\/pre>\n
This will build and install vapor<\/em>. <\/p>\n
Generating an application<\/strong><\/p>\n
Vapor will generate an application for us using <\/p>\n
\r\nvapor new hello-vapor -n\r\n<\/pre>\n
(obviously replace hello-vapor with your application name).<\/p>\n
As we’re using Linux, we’ll cd<\/em> into the hello-vapor<\/em> application folder and then run<\/p>\n
\r\nswift run\r\n<\/pre>\n
This will run, by default on localhost:8080 which is not great if you want to access remotely, so let’s instead start the application using<\/p>\n
\r\nswift run Run --hostname 0.0.0.0 --port 8080\r\n<\/pre>\n
Now if you connect to the server’s ip address, port 8080 you should see the default return “It works!” if you use http:\/\/localhost:8080\/hello you’ll see “Hello, world!” returned.<\/p>\n
If you take a look at the source generated by Vapor<\/em> and check the folder Sources\/App\/routes.swift you’ll see code like this<\/p>\n
\r\nimport Vapor\r\n\r\nfunc routes(_ app: Application) throws {\r\n    app.get { req in\r\n        return "It works!"\r\n    }\r\n\r\n    app.get("hello") { req -> String in\r\n        return "Hello, world!"\r\n    }\r\n}\r\n<\/pre>\n
As you can see this is routing the \/hello GET method to return “Hello, world!”.<\/p>\n
Using HTTP methods<\/strong><\/p>\n
As you can see from the previous code, app.get<\/em> denotes the method is a GET method, so let’s simply write an example of each of the HTTP methods, so change your routes.swift file to add the following<\/p>\n
\r\napp.get("method") { req -> String in\r\n   return "\\(req)"\r\n}\r\n\r\napp.post("method") { req -> String in\r\n   return "\\(req)"\r\n}\r\n\r\napp.put("method") { req -> String in\r\n   return "\\(req)"\r\n}\r\n\r\napp.patch("method") { req -> String in\r\n   return "\\(req)"\r\n}\r\n\r\napp.delete("method") { req -> String in\r\n   return "\\(req)"\r\n}\r\n<\/pre>\n
This doesn’t cover all HTTP methods, but we can use the alternate syntax to the above, which looks like this<\/p>\n
\r\napp.on(.GET, "method") { req -> String in\r\n   return "\\(req)"\r\n}\r\n<\/pre>\n
and simply replace .GET with each of the HTTP methods, such as .CONNECT, .OPTIONS, etc.<\/p>\n
Now let’s tests these – if we simply use CURL to execute each method, i.e.<\/p>\n
\r\ncurl -X GET localhost:8080\/method\r\ncurl -X POST localhost:8080\/method\r\ncurl -X PUT localhost:8080\/method\r\ncurl -X PATCH localhost:8080\/method\r\ncurl -X DELETE localhost:8080\/method\r\n<\/pre>\n
Parameters and Query Parameters<\/strong><\/p>\n
We’re also likely to need to handle parameters, so for example \/method\/aparam<\/p>\n
\r\napp.get("method", ":param") { req -> String in\r\n   let param = req.parameters.get("param")!        \r\n   return "\\(param) --> \\(req)"\r\n}\r\n<\/pre>\n
The : prefixing the param token is indicates the parameter is dynamic and hence we need to use req.parameters.get(“param”)!<\/em> to get the value from the param<\/em>.<\/p>\n
Finally for this post, what about if we want to pass query parameters, for example http:\/\/192.168.0.88:8080\/method?firstName=Scooby&lastName=Doo<\/p>\n
We can declare a struct to handle our expected query parameters like this<\/p>\n
\r\nstruct Person: Content {\r\n    var firstName: String?\r\n    var lastName: String?\r\n}\r\n<\/pre>\n
and now change our GET method to decode the query parameters into this struct, for example<\/p>\n
\r\napp.get("method") { req -> String in\r\n   let person = try req.query.decode(Person.self)\r\n   return "Firstname: \\(person.firstName!), Lastname \\(person.lastName!)"\r\n}\r\n<\/pre>\n
There’s a whole lot more functionality, as you’d expect, including streaming, validation etc. take a look at the Vapor Docs<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Vapor is a web application framework written in Swift. Installing on Linux As I’m more likely to be using a Linux server for my web application, that’s what we’ll use for this post. So following the Install on Linux instructione, I went the route of installing the toolbox for the toolbox repo (instructions recreated below) […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[286,324],"tags":[],"class_list":["post-9175","post","type-post","status-publish","format-standard","hentry","category-swift","category-vapor"],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/9175","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/comments?post=9175"}],"version-history":[{"count":5,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/9175\/revisions"}],"predecessor-version":[{"id":9181,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/posts\/9175\/revisions\/9181"}],"wp:attachment":[{"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/media?parent=9175"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/categories?post=9175"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/putridparrot.com\/blog\/wp-json\/wp\/v2\/tags?post=9175"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}