maxdesiatov / vapor-docs

Documentation markdown for all Vapor packages.

Vapor Documentation

This is the documentation for Vapor, a Web Framework for Swift that works on iOS, macOS, and Ubuntu; and all of the packages that Vapor offers.

Vapor is the most used web framework for Swift. It provides a beautifully expressive and easy to use foundation for your next website or API.

To view the framework's source code and code documentation, visit Vapor's GitHub.

How To Read

You can read this guide by clicking through the folders and markdown files on GitHub or through the rendered GitHub Pages.

Packages

Here are a list of all the Swift 3, linux-ready packages and modules provided open source by Vapor.

• Vapor: Swift's most used web framework.
  • Routing: Generic branch router.
  • HTTPRouting: HTTP router specializations.
  • Type-safe Routing: Generated route methods for type-safe parameters.
• Fluent: Models, relationships, and querying for NoSQL and SQL databases.
• Engine: Core transport layers.
  • HTTP: Pure Swift HTTP client and server.
  • URI: Pure Swift URI parsing and serializing.
  • WebSockets: Full-duplex communication channels over a single TCP connection.
  • SMTP: Send email using Sendgrid and Gmail.
  • Transport: Streams and transfer protocols.
• JSON: Maps Foundation JSON to Swifty enum.
• Console: Swift wrapper for console IO and commands.
• Node: A formatted data encapsulation meant to facilitate the object conversions.
• TLS: Swift OpenSSL and TLS.
• MySQL: Robust MySQL interface for Swift.
  • MySQL Driver: MySQL driver for Fluent.
  • MySQL Provider: MySQL provider for Vapor.
• SQLite: SQLite 3 wrapper for Swift
  • SQLite Driver: SQLite driver for Fluent.
  • SQLite Provider: SQLite provider for Vapor.
• PostgreSQL: Robust PostgreSQL interface for Swift.
  • PostgreSQL Driver: PostgreSQL driver for Fluent.
  • PostgreSQL Provider: PostgreSQL provider for Vapor.
• Mongo Driver: MongoKitten driver for Fluent.
• Polymorphic: Syntax for easily accessing values from generic data.
• Path Indexable: A protocol for powerful subscript access of data types.
• Core: Core extensions, type-aliases, and functions that facilitate common tasks.

Not all packages may be up to date with the latest Swift snapshot or Vapor release. Updating packages is an easy and great way to contribute!

Authors

Tanner Nelson, Logan Wright, and the hundreds of members of Vapor.