https://github.com/digipolitan/perfect-middleware
Perfect middleware swift allows developers to register middlewares inside a Perfect HTTPServer
https://github.com/digipolitan/perfect-middleware
middleware perfect perfect-server router swift swift-server
Last synced: 3 months ago
JSON representation
Perfect middleware swift allows developers to register middlewares inside a Perfect HTTPServer
- Host: GitHub
- URL: https://github.com/digipolitan/perfect-middleware
- Owner: Digipolitan
- License: bsd-3-clause
- Created: 2017-04-14T17:58:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-08T13:29:01.000Z (about 6 years ago)
- Last Synced: 2025-01-17T00:20:11.743Z (4 months ago)
- Topics: middleware, perfect, perfect-server, router, swift, swift-server
- Language: Swift
- Homepage:
- Size: 28.3 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
PerfectMiddleware
=================================
[](https://developer.apple.com/swift/)
[](http://twitter.com/Digipolitan)
Perfect middleware swift allows developer to register middlewares inside a Perfect HTTPServer
## Installation
### Swift Package Manager
To install PerfectMiddleware with SPM, add the following lines to your `Package.swift`.
```swift
let package = Package(
name: "XXX",
products: [
.library(
name: "XXX",
targets: ["XXX"]),
],
dependencies: [
.package(url: "https://github.com/Digipolitan/perfect-middleware-swift.git", from: "1.1.0")
],
targets: [
.target(
name: "XXX",
dependencies: ["PerfectMiddleware"])
]
)
```
## The Basics
Create an HTTPServer and register routes in the RouterMiddleware
```swift
let server = HTTPServer()
let router = RouterMiddleware()
router.get(path: "/").bind { (context) in
context.response.setBody(string: "It Works !").completed()
context.next()
}
server.use(router: router)
server.serverPort = 8887
do {
try server.start()
print("Server listening on port \(server.serverPort)")
} catch PerfectError.networkError(let err, let msg) {
print("Network error thrown: \(err) \(msg)")
}
```
Passing data between middlewares, you can provide 2 or more middleware for the same route and shared data across each middleware using the context
```swift
router.get(path: "/")
.bind { (context) in
context["name"] = "Steve"
context.next()
}
.bind { (context) in
guard let name = context["name"] as? String else {
return
}
context.response.setBody(string: "hello mr. \(name)!").completed()
context.next()
}
```
It's possible to create and register Middleware subsclasses instead of closures
```swift
class RandomMiddleware: Middleware {
func handle(context: RouteContext) throws {
context["rand"] = arc4random()
context.next()
}
}
```
Register Middleware as follow :
```swift
router.post(path: "/random")
.bind(RandomMiddleware())
.bind { (context) in
guard let rand = context["rand"] as? UInt32 else {
return
}
context.response.setBody(string: "the result \(rand)").completed()
context.next()
}
```
## Advanced
### Register middleware for all routes
it's possible to register middlewares before & after all child routes of the router
```swift
router.use(event: .beforeAll) { (context) in
context["start_date"] = Date()
context.next()
}.use(event: .afterAll) { (context) in
guard let startDate = context["start_date"] as? Date else {
return
}
let duration = Date().timeIntervalSince1970 - startDate.timeIntervalSince1970
print(String(duration * 1000) + " ms")
context.next()
}
```
This code will print the duration in second of the process for each route
### 404 handler
```swift
router.use(event: .notFound) { (context) in
context.response.setBody(string: "404").completed()
context.next()
}
```
### Error handler
```swift
router.use { (err, context) in
context.response.setBody(string: err.localizedDescription).completed()
context.next()
}
```
### Register sub routers
This code print "My name is" by calling "/user/name" path in your server
```swift
let router = RouterMiddleware()
let childRouter = RouterMiddleware()
childRouter.get(path: "/name")
.bind { (context) in
context.response.setBody(string: "My name is").completed()
context.next()
}
router.use(path: "/user", child: childRouter)
server.use(router: router)
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details!
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report
unacceptable behavior to [[email protected]](mailto:[email protected]).
## License
PerfectMiddleware is licensed under the [BSD 3-Clause license](LICENSE).