![Fire Image] (http://i.imgur.com/1qR6Nl4.png)
Blackfire
An extremely fast Swift web framework
π₯
Getting Started
If you're familiar with express.js then Blackfire will be known to you. The most simple example of how to use can be seen below:
main.swift
import Blackfire
// Create a nice new π₯ app for us to play with.
let app = Flame()
// Let's add a route to begin with.
app.get("/") { (req, res) in
res.send(text: "Hello World")
}
app.start(port: 3000) { result in
switch result {
case .success:
print("Server started on port 3000")
case .failure(let error):
print("Server failed with error: \(error)")
}
}
$ curl localhost:3000
Hello World%
π
Features
Blackfire has all the standard features of a typical minimal Web Framework, let's take a look at some of these.
π±
Routing
Routing, as seen in the above example, takes place by assigning a handler to a method in your App
app.get("/") { (req, res) in
res.send(text: "I'm a GET request")
}
app.post("/users") { (req, res) in
res.send(text: "I'm a POST request to /users")
}
app.delete("/all/files") { (req, res) in
res.send(text: "I'm a DELETE request to /all/files ...wait")
}
app.put("/em/up") { (req, res) in
res.send(text: "I'm a PUT request to /em/up Am I being robbed?")
}
This can become tedious if you have a lot of /users/<something> routes however, so we created the........
π
Router
Don't be scared that it's a monkey handling it, he had a pretty decent job interview on the whiteboard and seems to be doing ok.
The router object allows you to group routes together. For example
let users = Router()
users.get("/") { req, res in
res.send(text: "Get me all the users")
}
users.post("/") { req, res in
res.send(text: "Creating a new user")
}
users.get("/favourites") { req, res in
res.send(json: ["food": "π"])
}
// Let's use the router to match for /users
app.use("/users", users)
$ curl localhost:3000/users
Get me all the users%
$ curl localhost:3000/users/favourites
{"food":"π"}%
Powerful stuff.
π«
Request
The request or req object contains a bunch of helpful information that your handler may want to use:
These include:
request.paramsA key value pair ofStringsthat are matched in the routerequest.bodyThe raw body of the recieved request, in the form of aStringrequest.headersA key value pair ofStringsof the headers that appeared in the routerequest.methodThe method of this request, formed from theHTTPMethodenum.request.pathThe path of this requestrequest.httpProtocolThe protocol for this request.
π£
Response
The response or res object contains everything you need to return data back to the consumer
res.send(text: String)Send back a basic text response in the form ofContent-Type: text/plainres.send(json: Any)Send back some JSON, takes in a JSON parseable object. This method can fail if the object is not parseableres.send(status: Int)Send back a HTTP status with no bodyres.send(html: String)Send back some html with the header ofContent-Type: text/htmlres.send(error: String)Sends back an error, setting the status to500.res.headersSet some headers to send back to the client
π
Threading
Threading is a contentious issue when it comes to web frameworks, the age old question of Single vs Multithreaded is enough to start a flame war.
So let's fight the fire with fire and solve it once and for all.
πΈ
Queue Types
A Flame app can take a type of either .serial or .concurrent. These do exactly as they say on the tin and allow for either all requests to be handled via DispatchQueue.main or DispatchQueue.global().
Why did we do this?
We think that giving you the power to choose which type you want for your app is a good thing. We're not sorry.
Just as an FYI, we chose to go with .serial as the default setting. It was a 50/50 chance we got it right. Good thing it can be changed.
Example
// An app which handles only on the main thread.
let app = Flame(type: .serial)
// An app which handles on multiple concurrent threads.
let app = Flame(type: .concurrent)
35 Apr 18, 2022
10.2k Dec 29, 2022
7.6k Jan 6, 2023
2k Dec 5, 2022
316 Oct 6, 2022
22.4k Jan 2, 2023
170 Nov 15, 2022
46 Jan 29, 2022
1.5k Dec 28, 2022
246 Sep 9, 2022
1.9k Dec 22, 2022
479 Nov 22, 2022
52 Oct 26, 2022
925 Nov 17, 2022
377 Jun 29, 2022
68 Jul 25, 2022
745 Jan 3, 2023
1.1k Dec 16, 2022
0 Nov 27, 2021
