Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crossroadlabs/Express
Swift Express is a simple, yet unopinionated web application server written in Swift
https://github.com/crossroadlabs/Express
asynchronous crossroad-labs linux linux-support reactive server swift swift-express
Last synced: 7 days ago
JSON representation
Swift Express is a simple, yet unopinionated web application server written in Swift
- Host: GitHub
- URL: https://github.com/crossroadlabs/Express
- Owner: crossroadlabs
- License: gpl-3.0
- Created: 2016-02-04T21:06:46.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-12-22T09:38:23.000Z (almost 6 years ago)
- Last Synced: 2024-08-15T19:08:03.052Z (4 months ago)
- Topics: asynchronous, crossroad-labs, linux, linux-support, reactive, server, swift, swift-express
- Language: Swift
- Size: 508 KB
- Stars: 848
- Watchers: 42
- Forks: 47
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Express - Swift Express is a simple, yet unopinionated web application server written in Swift. (Server / Keychain)
- awesome-ios-star - Express - Swift Express is a simple, yet unopinionated web application server written in Swift. (Server / Keychain)
- awesome-swift-cn - Express - Swift Web Application framework, supporting both Synchronous and Asynchronous (Futures based) styles. Inspired by Play framework and Express.js. (Libs / Network)
README
[//]: https://www.iconfinder.com/icons/383207/doc_tag_icon#size=64
Documentation 
Live 🐧 server running Demo 
Eating our own dog food 
[](https://travis-ci.org/crossroadlabs/Express)
[](https://swift.org/package-manager/)
[](https://raw.githubusercontent.com/crossroadlabs/Express/master/LICENSE)
[](https://github.com/crossroadlabs/Express/releases)
UPDATE March 2017: Swift Express is back on track and is Swift 3.x compatible. From now on we will suport the latest stable swift builds only. There is no release of the newest version done yet, though you can enjoy it from the "master" branch. Stay tuned.
Version 0.3.x (current stable) notice: Current version works with Xcode 7.2, 7.3 and Linux DEV SNAPSHOT released on 03.01.2016. Upcoming version (0.4.x) will fully support Swift 3.0 and will maintain compatibility with Swift 2.2 (Xcode 7.3). Stay tuned by following us on social networks.
### Being [perfectionists](http://www.crossroadlabs.xyz), we took the best from what we think is the best: power of [Play Framework](https://www.playframework.com/) and simplicity of [Express.js](http://expressjs.com/)
#### Express is an asynchronous, simple, powerful, yet unopinionated web application server written in Swift
## Getting started
First make sure, please, you have followed the [installation](#installation) section steps.
##### Create a project:
```sh
swift-express init HelloExpress
cd HelloExpress
swift-express bootstrap
open HelloExpress.xcodeproj
```
##### Create new API:
```swift
app.get("/myecho") { request in
.ok(request.query["message"]?.first)
}
```
##### Run from xCode or command line with:
```sh
swift-express build
swift-express run
```
Test it in the browser: [http://localhost:9999/myecho?message=Hello](http://localhost:9999/myecho?message=Hello)
##### A complete Swift Express command line documentation can be found here: [https://github.com/crossroadlabs/ExpressCommandLine](https://github.com/crossroadlabs/ExpressCommandLine)
## Installation
[//]: # (Icons are here: https://www.iconfinder.com/icons/395228/linux_tox_icon#size=16)
### [OS X ](http://www.apple.com/osx/)
##### First install the following components (if you have not yet):
* [XCode](https://developer.apple.com/xcode/download/) 7.2 or higher
* [Homebrew](http://brew.sh/) the latest available version
* Command Line tools: run ```xcode-select --install``` in terminal
##### Run the following in terminal:
```sh
brew tap crossroadlabs/tap
brew install swift-express
```
#### [Linux ](http://www.linux.org/)
##### For instructions on how to get [Express](http://swiftexpress.io/) installed on Linux, please, refer to the [installation section](./doc/gettingstarted/installing.md#linux-) in the [ducumentation](./doc/index.md).
## Examples
Create a project as it is described in the [getting started](#getting-started) section. Now you can start playing with examples.
All the examples can be found in `Demo` project inside the main repo.
### Hello Express:
```swift
app.get("/hello") { request in
.ok(AnyContent(str: "
Hello Express!!!
", contentType: "text/html"))
}
```
Launch the app and follow the link: [http://localhost:9999/hello?message=Hello](http://localhost:9999/hello?message=Hello)
### Synchronous vs Asynchronous
If you don't know what this is you might want to better skip it for now to the next section: [URL params](#url-params). To get more information see [this](http://cs.brown.edu/courses/cs168/s12/handouts/async.pdf) first. We have our APIs based on [Future pattern](https://en.wikipedia.org/wiki/Futures_and_promises). Our implementation is based on [BrightFutures](https://github.com/Thomvis/BrightFutures), thanks @Thomvis!
Express can handle it both ways. All your syncronous code will be executed in a separate queue in a traditional way, so if you are a fan of this approach - it will work (like in "Hello Express" example above).
Still if you want to benefit from asynchronicity, we provide a very powerful API set that accepts futures as result of your handler.
Let's assume you have following function somewhere:
```swift
func calcFactorial(num:Double) -> Future
```
it's a purely asyncronous function that returns future. It would be really nice if it could be handled asynchronously as well in a nice functional way. Here is an example of how it could be done.
```swift
// (request -> Future, AnyError> in) - this is required to tell swift you want to return a Future
// hopefully inference in swift will get better eventually and just "request in" will be enough
app.get("/factorial/:num(\\d+)") { request -> Future, AnyError> in
// get the number from the url
let num = request.params["num"].flatMap{Double($0)}.getOrElse(0)
// get the factorial Future. Returns immediately - non-blocking
let factorial = calcFactorial(num)
//map the result of future to Express Action
let future = factorial.map { fac in
Action.ok(String(fac))
}
//return the future
return future
}
```
### URL params
Let's get our echo example from [Getting Started](#getting-started) a bit further. Our routing engine, which is largely based on NodeJS analog [path-to-regex](https://github.com/pillarjs/path-to-regexp). You can read the complete documentation on how to use path patterns [here](https://github.com/pillarjs/path-to-regexp). Now an example with URL param:
```swift
//:param - this is how you define a part of URL you want to receive through request object
app.get("/echo/:param") { request in
//here you get the param from request: request.params["param"]
.ok(request.params["param"])
}
```
### Serving static files
```swift
app.get("/:file+", action: StaticAction(path: "public", param:"file"))
```
The code above tells Express to serve all static files from the public folder recursively. If you want to serve just the first level in folder, use:
```swift
app.get("/:file", action: StaticAction(path: "public", param:"file"))
```
The difference is just in the pattern: `/:file` versus `/:file+`. For more information see our routing section.
### Serving JSON requests
First of all we need to register the JSON view in the system:
```swift
//now we can refer to this view by name
app.views.register(JsonView())
```
Let's say we want to build a simple API for users registration. We want our API consumers to `POST` to `/api/user` a JSON object and get a `JSON` response back.
```swift
app.post("/api/user") { request in
//check if JSON has arrived
guard let json = request.body?.asJSON() else {
return Action.ok("Invalid request")
}
//check if JSON object has username field
guard let username = json["username"].string else {
return Action.ok("Invalid request")
}
//compose the response as a simple dictionary
let response =
["status": "ok",
"description": "User with username '" + username + "' created succesfully"]
//render disctionary as json (remember the one we've registered above?)
return .render(JsonView.name, context: response)
}
```
Lines above will do the job. Post this `JSON`:
```json
{
"username": "swiftexpress"
}
```
to our api URL: `http://localhost:9999/api/user` (don't forget `application/json` content type header) and you will get this response:
```json
{
"status": "ok",
"description": "User with username 'swiftexpress' created succesfully"
}
```
### Using template engine
First of all you need to switch the template engine on:
```swift
//we recommend mustache template engine
app.views.register(StencilViewEngine())
```
Now create a file called `hello.stencil` in the `views` directory:
```stencil
Hello from Stencil: {{user}}
```
Add a new request handler:
```swift
//user as an url param
app.get("/hello/:user.html") { request in
//get user
let user = request.params["user"]
//if there is a user - create our context. If there is no user, context will remain nil
let context = user.map {["user": $0]}
//render our template named "hello"
return .render("hello", context: context)
}
```
Now follow the link to see the result: [http://localhost:9999/hello/express.html](http://localhost:9999/hello/express.html)
### If you want more, please, visit our [documentation](./doc/index.md) page
## Ideology behind
### Taking the best of Swift
[Swift](https://swift.org/) essentially is a new generation programming language combining simplicity and all the modern stuff like functional programming.
We were inspired (and thus influenced) mainly by two modern web frameworks: [Express.js](http://expressjs.com/) and [Play](https://www.playframework.com/). So, we are trying to combine the best of both worlds taking simplicity from [Express.js](http://expressjs.com/) and modern robust approach of [Play](https://www.playframework.com/)
Let us know if we are on the right path! Influence the project, create feature requests, API change requests and so on. While we are in our early stages, it's easy to change. We are open to suggestions!
## Features
* 🐧 Linux support with and without [Dispatch](https://swift.org/core-libraries/#libdispatch)
* 100% asynchronous (Future-based API)
* Flexible and extensible
* Full [MVC](https://ru.wikipedia.org/wiki/Model-View-Controller) support
* Swift 2.1 and 2.2 compatible
* [Simple routing mechanism](./doc/gettingstarted/routing.md)
* Request handlers chaining
* [Typesafe Error Handlers](./doc/gettingstarted/errorhandling.md)
* Templates: [Stencil](https://github.com/kylef/Stencil) and [Mustache](https://mustache.github.io)
* Built-in [JSON](http://www.json.org) support
* Easy creation of [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) APIs
* Built-in [static files serving](./doc/gettingstarted/static.md)
* Multiple contents types built-in support
### And heah, the most important feature: [Highly passionate development team](http://www.crossroadlabs.xyz/)
## Roadmap
* v0.4: stable version with Swift 3.0
* v0.5: proper streaming
* v0.6: new core (based on [Reactive Swift](https://github.com/reactive-swift))
* v0.7: more content types available out of the box
* v0.8: Web Sockets
* v0.9: hot code reload
* v1.0: hit the production!
## Changelog
* v0.4: Swift 3.0
* Ported Express to Swift 3.0
* Moved to [Reactive Swift](https://github.com/reactive-swift) foundation ([Execution contexts](https://github.com/reactive-swift/ExecutionContext), [Futures](https://github.com/reactive-swift/Future), etc.)
* Wrapped libevent as an [ExecutionContext](https://github.com/reactive-swift/ExecutionContext)
* Dropped [Carthage](https://github.com/Carthage/Carthage) support
* v0.3: linux support
* Runs on linux with and without [Dispatch](https://swift.org/core-libraries/#libdispatch) support (see [installation section](./doc/gettingstarted/installing.md#linux-) and [building in production](./doc/gettingstarted/buildrun.md#production-build))
* FormUrlEncoded ContentType support
* Merged Query (params from both query string and form-url-encoded body merged together)
* Utility methods (redirect, status, etc)
* [Stencil](https://github.com/kylef/Stencil) Templete Engine Support
* Replaced [SwiftyJSON](https://github.com/SwiftyJSON/SwiftyJSON) with [TidyJSON](https://github.com/benloong/TidyJSON)
* [Typesafe Error Handlers](./doc/gettingstarted/errorhandling.md)
* Better Demo app
* v0.2.1: minor changes
* Swift modules are installed via Carthage
* Enabled binary builds on OS X
* v0.2: Solid OS X release
* Much better routing APIs
* Advanced routing path patterns
* Possibility to use Regex for routing
* Greately improved README
* Some bugfixes
* v0.1: Initial Public Release
* basic routing
* views and view engines (supports [Mustache](https://mustache.github.io/))
* JSON rendering as a view
* query parsing
* static files serving
## Contributing
To get started, sign the Contributor License Agreement.
## [ by Crossroad Labs](http://www.crossroadlabs.xyz/)