A Swift Web Framework and HTTP Server
Kitura is a web framework and web server that is created for web services written in Swift. For more information, visit www.kitura.io.
- URL routing (GET, POST, PUT, DELETE)
- URL parameters
- Static file serving
- FastCGI support
- SSL/TLS support
- JSON parsing
- Pluggable middleware
Version 1.0
of Kitura requires Swift 3.0. Kitura is unlikely to compile with any other version of Swift.
- Download and install Xcode 8.
- There is no step 2.
Now you are ready to develop your first Kitura app. Check Kitura-Sample or see Getting Started.
Note: if you have been using the Xcode 8 betas, you may also need to run
sudo xcode-select -r
to reset your selected developer directory.
Kitura is tested on Ubuntu 14.04 LTS and Ubuntu 15.10.
- Install the following system linux libraries:
$ sudo apt-get install libcurl4-openssl-dev uuid-dev
- Install the required Swift version from
swift.org
.
After installing it (i.e. extracting the .tar.gz
file), make sure you update your PATH
environment variable so that it includes the extracted tools: export PATH=/<path to uncompress tar contents>/usr/bin:$PATH
.
Now you are ready to develop your first Kitura app. Check Kitura-Sample or see Getting Started.
-
Install Docker on your development system.
-
Pull down the kitura-ubuntu image from Docker Hub:
$ docker pull ibmcom/kitura-ubuntu:latest
- Create a Docker container using the
kitura-ubuntu
image you just downloaded and forward port 8090 on host to the container:
$ docker run -i -p 8090:8090 -t ibmcom/kitura-ubuntu:latest /bin/bash
- From within the Docker container, execute the
clone_build_kitura.sh
script to build the Kitura-Starter-Bluemix sample project:
# /root/clone_build_kitura.sh
The last two output lines from executing the clone_build_kitura.sh
script should be similar to:
Linking .build/debug/Kitura-Starter-Bluemix
>> Build for Kitura-Starter-Bluemix completed (see above for results).
- You can now run the Kitura-Starter-Bluemix executable inside the Docker container:
# /root/start_kitura_sample.sh
You should see an output message that contains the string Listening on port 8090
.
- Visit
http://localhost:8090/
in your web browser.
-
Install VirtualBox.
-
Install Vagrant.
-
From the root of the Kitura folder containing the
vagrantfile
, create and configure a guest machine:
$ vagrant up
- SSH into the Vagrant machine:
$ vagrant ssh
- As needed for development, edit the
vagrantfile
to setup Synced Folders to share files between your host and guest machine.
Now you are ready to develop your first Kitura app. Check Kitura-Sample or see Getting Started.
Let's develop your first Kitura web application!
- First, create a new project directory.
$ mkdir myFirstProject
- Next, create a new Swift project using the Swift Package Manager.
$ cd myFirstProject
$ swift package init --type executable
Now your directory structure under myFirstProject should look like this:
myFirstProject ├── Package.swift ├── Sources │ └── main.swift └── Tests └── empty
Note: For more information on the Swift Package Manager, go here.
- In
Package.swift
, add Kitura as a dependency for your project.
import PackageDescription
let package = Package(
name: "myFirstProject",
dependencies: [
.Package(url: "https://github.com/IBM-Swift/Kitura.git", majorVersion: 1, minor: 0)
])
- In
Sources/main.swift
, import the Kitura module.
import Kitura
- Add a router and a path:
let router = Router()
router.get("/") {
request, response, next in
response.send("Hello, World!")
next()
}
- Add an HTTP server and start the Kitura framework.
Kitura.addHTTPServer(onPort: 8090, with: router)
Kitura.run()
- Your
Sources/main.swift
file should now look like this.
import Kitura
let router = Router()
router.get("/") {
request, response, next in
response.send("Hello, World!")
next()
}
Kitura.addHTTPServer(onPort: 8090, with: router)
Kitura.run()
-
Optionally, add logging.
In the code example above, no messages from Kitura will logged. You may want to add a logger to help diagnose any problems that occur.
Add a HeliumLogger dependency to
Package.swift
.import PackageDescription let package = Package( name: "myFirstProject", dependencies: [ .Package(url: "https://github.com/IBM-Swift/Kitura.git", majorVersion: 1, minor: 0), .Package(url: "https://github.com/IBM-Swift/HeliumLogger.git", majorVersion: 1, minor: 0) ])
Enable HeliumLogger in
Sources/main.swift
.import HeliumLogger HeliumLogger.use()
Here is the finished
Sources/main.swift
file.import Kitura import HeliumLogger HeliumLogger.use() let router = Router() router.get("/") { request, response, next in response.send("Hello, World!") next() } Kitura.addHTTPServer(onPort: 8090, with: router) Kitura.run()
-
Compile your application:
$ swift build
Or copy our Makefile and build scripts to your project directory and run make build
. You may want to customize this Makefile and use it for building, testing and running your application. For example, you can clean your build directory, refetch all the dependencies, build, test and run your application by running make clean refetch test run
.
- Now run your new web application:
$ .build/debug/myFirstProject
- Open your browser at http://localhost:8090
All improvements to Kitura are very welcome! Here's how to get started with developing Kitura itself.
- Clone this repository.
$ git clone https://github.com/IBM-Swift/Kitura
- Build and run tests.
$ make test
You can find more info on contributing to Kitura in our contributing guidelines.
We love to talk server-side Swift, and Kitura. Join our Slack to meet the team!