Skip to content
Get packs

Guide · Open source

How to use Vapor: install the Swift web framework

Updated · written with AI from the project's own documentation and checked against our catalogue data

Vapor is an open-source HTTP web framework for Swift, the language Apple created. It gives you a foundation for websites, APIs and cloud services that run on a server instead of on a user's device. This guide shows you what you need, how to get the source code, where to find the docs and help, and whether Vapor fits your project.

Vaporvapor/vapor · ★ 26.2k · MIT

Quick start

  1. 1Check the prerequisite. Install Swift 6.0 or later, as listed in the README.
  2. 2Clone the repository. Run git clone https://github.com/vapor/vapor.git to download the source code.
  3. 3Follow the build instructions. The project uses a clone-and-build install method, so follow the setup steps in the README and documentation to build it.
  4. 4Read the documentation. Open docs.vapor.codes/4.0 to learn the framework's concepts and APIs.
  5. 5Ask for help. Join the Vapor Discord at vapor.team to talk to other developers.

What Vapor is and who it is for

Vapor is an HTTP web framework for Swift. The README describes it as providing an expressive and easy-to-use foundation for websites, APIs or cloud projects.

It suits developers who already write Swift for iOS or macOS apps and want to build the backend in the same language. It also suits teams building JSON APIs or web backends in Swift.

  • Good fit: Swift developers who want backend services in the same language as their apps
  • Good fit: teams building JSON APIs or web backends who already work in Swift
  • Not a fit: people with no Swift experience, since the framework assumes Swift knowledge
  • Not a fit: projects that depend on a mature library ecosystem in another language such as Python or JavaScript

What you need before you start

The README lists Swift 6.0 or later as a prerequisite, shown in its badge. Install a current Swift toolchain before you clone the project.

Because the framework assumes Swift knowledge, it helps to be comfortable with the language first. Also note that the newest listed release is a beta, so if you need the latest stable release you should check the repository's release listings before you commit.

Get the Vapor source code

Vapor is installed by cloning the repository and building it. The README gives this command to clone the project from GitHub.

git clone https://github.com/vapor/vapor.git

Find the documentation and get help

The README links to documentation at docs.vapor.codes under the 4.0 path, and to a community Discord at vapor.team. The community is described as welcoming, and the README also points to a list of projects built with Vapor, called awesome-vapor.

To request a feature, open an issue on GitHub or bring the idea up on Discord. To report a bug, create an issue. Report security vulnerabilities by emailing security@vapor.codes as soon as possible.

  • Documentation: docs.vapor.codes/4.0
  • Community chat: Discord at vapor.team
  • Example projects: github.com/vapor-community/awesome-vapor
  • Bugs: GitHub issues
  • Security: security@vapor.codes

Compare Vapor with other Swift frameworks

The source names Hummingbird, Kitura and Perfect as comparable projects. The README does not compare them in detail, so test the options against your own needs before choosing one.

Vapor is MIT licensed, as shown by the licence badge and the LICENSE file linked from the README.

  • Hummingbird
  • Kitura
  • Perfect

What people use it for

  • Building a JSON API for an iOS or macOS app in Swift
  • Creating a web backend for a website written in Swift
  • Running cloud services on a server with the same language as your client apps

Frequently asked questions

What are the requirements for Vapor?

The README lists Swift 6.0 or later as the prerequisite. Vapor assumes you already know Swift, so it is best suited to developers with Swift experience.

Is Vapor free to use?

Vapor is MIT licensed, according to the licence badge and the LICENSE file linked from the README. The MIT licence is a permissive open-source licence.

How do I install Vapor?

The README's install method is to clone the repository with git clone https://github.com/vapor/vapor.git and then build it. Follow the README and documentation for the build steps.

Is Vapor good for beginners?

Not according to the source. The project is aimed at people who already know Swift, so beginners without Swift experience should learn the language first.

What are the alternatives to Vapor?

The source lists Hummingbird, Kitura and Perfect as comparable Swift projects. Compare them on your own project needs, since the README does not benchmark them.

Is Vapor ready for production?

The source does not make a production-readiness claim. It does note that the newest listed release is a beta, so teams that need the latest stable release should check release status first.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Vapor is a good choice for Swift developers who want to build APIs or web backends in the same language as their apps, and who are comfortable working with Swift and the 6.0 toolchain. If you have no Swift experience, need a stable release only, or depend on a large library ecosystem in Python or JavaScript, look at other options.

Install options & downloads