Vapor

https://docs.vapor.codes
Admin
Vapor is an HTTP web framework for Swift designed to build backends, web applications, APIs, and...
Tokens:78,544
Snippets:1,213
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Services

Source: https://docs.vapor.codes/deploy/docker

Starts the application and its dependencies defined in the Docker Compose file.

```bash
docker compose up app
```

--------------------------------

### Start Multiple Services

Source: https://docs.vapor.codes/deploy/docker

Starts both the application and database services explicitly.

```bash
docker-compose up app db
```

--------------------------------

### Example updated configure method

Source: https://docs.vapor.codes/upgrading

This example demonstrates configuring databases, migrations, and routes using the new Application instance.

```swift
import Fluent  
import FluentSQLiteDriver  
import Vapor  
   
// Called before your application initializes.  
public func configure(_ app: Application) throws {  
    // Serves files from `Public/` directory  
    // app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))  
    // Configure SQLite database  
    app.databases.use(.sqlite(.file("db.sqlite")), as: .sqlite)  
   
    // Configure migrations  
    app.migrations.add(CreateTodo())  
      
    try routes(app)  
}
```

--------------------------------

### Install Swift via Swiftly

Source: https://docs.vapor.codes/deploy/digital-ocean

Use the Swiftly CLI to install the latest stable version of Swift.

```bash
$ swiftly install latest  
   
Fetching the latest stable Swift release...  
Installing Swift 5.9.1  
Downloaded 488.5 MiB of 488.5 MiB  
Extracting toolchain...  
Swift 5.9.1 installed successfully!  
   
$ swift --version  
   
Swift version 5.9.1 (swift-5.9.1-RELEASE)  
Target: x86_64-unknown-linux-gnu
```

--------------------------------

### Install Vapor Toolbox via Homebrew

Source: https://docs.vapor.codes/install/macos

Use Homebrew to install the Vapor CLI tool.

```bash
brew install vapor
```

--------------------------------

### Install flyctl on Linux

Source: https://docs.vapor.codes/deploy/fly

Use the provided install script to set up the Fly CLI on Linux systems.

```bash
curl -L https://fly.io/install.sh | sh
```

--------------------------------

### Start Services with Custom Log Level

Source: https://docs.vapor.codes/deploy/docker

Starts the application with a specific environment variable for logging.

```bash
LOG_LEVEL=trace docker-compose up app
```

--------------------------------

### Start Vapor App with Supervisor

Source: https://docs.vapor.codes/deploy/supervisor

Commands to reload configuration and start the managed application process.

```bash
| supervisorctl reread  
---|---  
| supervisorctl add hello  
| supervisorctl start hello  
```

--------------------------------

### Example GET Request with Query String

Source: https://docs.vapor.codes/basics/content

A sample HTTP request containing a name parameter in the query string.

```http
| GET /hello?name=Vapor HTTP/1.1  
---|---  
| content-length: 0  
Copy
```

--------------------------------

### Run and Verify Vapor Application

Source: https://docs.vapor.codes/deploy/digital-ocean

Start the application and verify connectivity.

```bash
swift run App serve --hostname 0.0.0.0 --port 8080
```

```bash
$ curl http://134.122.126.139:8080  
It works!
```

```bash
[ NOTICE ] Server starting on http://0.0.0.0:8080  
[ INFO ] GET /
```

--------------------------------

### Install Supervisor on Ubuntu

Source: https://docs.vapor.codes/deploy/supervisor

Use apt-get to install the supervisor package on Ubuntu systems.

```bash
| sudo apt-get update  
---|---  
| sudo apt-get install supervisor  
```

--------------------------------

### Pagination request example

Source: https://docs.vapor.codes/fluent/query

Example of a GET request URI for pagination.

```http
GET /planets?page=2&per=5 HTTP/1.1
```

--------------------------------

### Install Nginx on Fedora

Source: https://docs.vapor.codes/deploy/nginx

Use the dnf package manager to install Nginx.

```bash
sudo dnf install nginx
```

--------------------------------

### Build Vapor Toolbox

Source: https://docs.vapor.codes/deploy/digital-ocean

Clone, build, and install the Vapor Toolbox binary.

```bash
git clone https://github.com/vapor/toolbox.git
```

```bash
cd toolbox  
git checkout 18.6.0
```

```bash
swift build -c release --disable-sandbox --enable-test-discovery  
sudo mv .build/release/vapor /usr/local/bin
```

--------------------------------

### Example Swift version output

Source: https://docs.vapor.codes/install/macos

Sample output showing the Swift version and target architecture.

```text
| swift-driver version: 1.75.2 Apple Swift version 5.8 (swiftlang-5.8.0.124.2 clang-1403.0.22.11.100)  
---|---  
| Target: arm64-apple-macosx13.0
```

--------------------------------

### Verify Vapor Toolbox installation

Source: https://docs.vapor.codes/install/macos

Confirm the Vapor CLI is installed by displaying the help menu.

```bash
vapor --help
```

--------------------------------

### Install Nginx on Ubuntu

Source: https://docs.vapor.codes/deploy/nginx

Use apt-get to update package lists and install the Nginx package.

```bash
| sudo apt-get update  
---|---  
| sudo apt-get install nginx
```

--------------------------------

### Example URL

Source: https://docs.vapor.codes/basics/routing

The URL representation of the example HTTP request.

```text
http://vapor.codes/hello/vapor
```

--------------------------------

### Install Supervisor on Fedora

Source: https://docs.vapor.codes/deploy/supervisor

Use dnf to install the supervisor package on Fedora.

```bash
sudo dnf install supervisor
```

--------------------------------

### Create a Leaf template

Source: https://docs.vapor.codes/leaf/getting-started

Example content for a hello.leaf file.

```html
Hello, #(name)!
```

--------------------------------

### Install Swift on Fedora

Source: https://docs.vapor.codes/install/linux

Install the Swift language package using the dnf package manager.

```bash
sudo dnf install swift-lang
```

--------------------------------

### Start the Vapor server

Source: https://docs.vapor.codes/advanced/server

The default command to launch the Vapor application server.

```bash
swift run App serve
```

--------------------------------

### Example Token Output

Source: https://docs.vapor.codes/security/authentication

A sample representation of a generated authentication token.

```text
8gtg300Jwdhc/Ffw784EXA==
```

--------------------------------

### Example HTTP GET Request

Source: https://docs.vapor.codes/basics/routing

A raw HTTP GET request structure targeting a specific path.

```http
| GET /hello/vapor HTTP/1.1  
---|---  
| host: vapor.codes  
| content-length: 0
```

--------------------------------

### Configure Supervisor for Vapor

Source: https://docs.vapor.codes/deploy/supervisor

Example configuration file for a Vapor project located at /etc/supervisor/conf.d/hello.conf.

```ini
| [program:hello]  
---|---  
| command=/home/vapor/hello/.build/release/App serve --env production  
| directory=/home/vapor/hello/  
| user=vapor  
| stdout_logfile=/var/log/supervisor/%(program_name)s-stdout.log  
| stderr_logfile=/var/log/supervisor/%(program_name)s-stderr.log  
```

--------------------------------

### Example Heroku configuration output

Source: https://docs.vapor.codes/deploy/heroku

Sample output showing the DATABASE_URL environment variable provided by Heroku.

```text
=== today-i-learned-vapor Config Vars
DATABASE_URL: postgres://cybntsgadydqzm:2d9dc7f6d964f4750da1518ad71hag2ba729cd4527d4a18c70e024b11cfa8f4b@ec2-54-221-192-231.compute-1.amazonaws.com:5432/dfr89mvoo550b4
```

--------------------------------

### Start Services in Detached Mode

Source: https://docs.vapor.codes/deploy/docker

Starts the application in the background.

```bash
docker compose up --detach app
```

--------------------------------

### Request Log Output Example

Source: https://docs.vapor.codes/basics/logging

Example of the log output format including the request-id.

```text
[ INFO ] Hello, logs! [request-id: C637065A-8CB0-4502-91DC-9B8615C5D315] (App/routes.swift:10)
```

--------------------------------

### Switching logic based on environment

Source: https://docs.vapor.codes/basics/environment

Use app.environment within the configure method to execute environment-specific setup logic.

```swift
switch app.environment {  
case .production:  
    app.databases.use(....)  
default:  
    app.databases.use(...)  
}
```

--------------------------------

### Example project path output

Source: https://docs.vapor.codes/getting-started/xcode

The expected output format when running the pwd command.

```text
/path/to/project
```

--------------------------------

### Install Nginx on CentOS and Amazon Linux

Source: https://docs.vapor.codes/deploy/nginx

Use the yum package manager to install Nginx.

```bash
sudo yum install nginx
```

--------------------------------

### Making a GET Request

Source: https://docs.vapor.codes/basics/client

Perform a GET request using the client's convenience method.

```swift
let response = try await req.client.get("https://httpbin.org/status/200")
```

--------------------------------

### HTTP POST request example

Source: https://docs.vapor.codes/fluent/overview

Example of a JSON payload for creating a new galaxy via a POST request.

```http
POST /galaxies HTTP/1.1  
content-length: 21  
content-type: application/json  
   
{  
    "name": "Milky Way"  
}
```

--------------------------------

### Install flyctl on macOS

Source: https://docs.vapor.codes/deploy/fly

Use Homebrew to install the Fly CLI tool on macOS systems.

```bash
brew install flyctl
```

--------------------------------

### Verify Swift installation

Source: https://docs.vapor.codes/install/macos

Check the installed version of Swift to ensure compatibility with Vapor 4.

```bash
swift --version
```

--------------------------------

### Manually manage server lifecycle

Source: https://docs.vapor.codes/advanced/server

Programmatically start, shut down, and wait for the server to exit.

```swift
// Start Vapor's server.
try app.server.start()
// Request server shutdown.
app.server.shutdown()
// Wait for the server to shutdown.
try app.server.onShutdown.wait()
```

--------------------------------

### Defining Path Components

Source: https://docs.vapor.codes/basics/routing

Examples of different path component types including constants, parameters, anything, and catchall.

```swift
app.get("foo", "bar", "baz") { req in  
    ...  
}
```

```swift
app.get("foo", ":bar", "baz") { req in  
    ...  
}
```

```swift
app.get("foo", "*", "baz") { req in  
    ...  
}
```

```swift
app.get("foo", "**") { req in   
    ...  
}
```

--------------------------------

### User Registration Request

Source: https://docs.vapor.codes/security/authentication

Example HTTP request to create a new user.

```http
POST /users HTTP/1.1
Content-Length: 97
Content-Type: application/json

{
    "name": "Vapor",
    "email": "test@vapor.codes",
    "password": "secret42",
    "confirmPassword": "secret42"
}
```

--------------------------------

### Install Supervisor on CentOS and Amazon Linux

Source: https://docs.vapor.codes/deploy/supervisor

Use yum to install the supervisor package on CentOS and Amazon Linux.

```bash
sudo yum install supervisor
```

--------------------------------

### Example Error Response

Source: https://docs.vapor.codes/deploy/docker

JSON error output returned when the database schema is not initialized.

```json
{"error":true,"reason":"Something went wrong."}
```

--------------------------------

### Initialize Vapor Project

Source: https://docs.vapor.codes/deploy/digital-ocean

Create a new project using the Vapor Toolbox.

```bash
vapor new HelloWorld -n
```

```bash
cd HelloWorld
```

--------------------------------

### JSON response example

Source: https://docs.vapor.codes/fluent/overview

The expected JSON response after successfully creating a model.

```json
{
    "id": ...,
    "name": "Milky Way"
}
```

--------------------------------

### Example GET Request without Query String

Source: https://docs.vapor.codes/basics/content

A sample HTTP request where the query string is omitted.

```http
| GET /hello HTTP/1.1  
---|---  
| content-length: 0  
Copy
```

--------------------------------

### Manage service lifecycle with systemctl

Source: https://docs.vapor.codes/deploy/systemd

Commands to reload, enable, start, stop, and restart the configured Vapor service.

```bash
systemctl daemon-reload
systemctl enable hello
systemctl start hello
systemctl stop hello
systemctl restart hello
```

--------------------------------

### Bootstrapping LoggingSystem

Source: https://docs.vapor.codes/basics/logging

Configure the logging system in entrypoint.swift using Vapor's helper method.

```swift
var env = try Environment.detect()  
try LoggingSystem.bootstrap(from: &env)
```

--------------------------------

### Fetch Apple JWKS URL

Source: https://docs.vapor.codes/security/jwt

Example URL for retrieving Sign in with Apple JWKS.

```text
GET https://appleid.apple.com/auth/keys
```

--------------------------------

### Initialize Application for Testing

Source: https://docs.vapor.codes/advanced/testing

Use the .testing environment and ensure app.shutdown() is called to release resources.

```swift
let app = Application(.testing)  
defer { app.shutdown() }  
try configure(app)
```

--------------------------------

### Automate migrations with release_command

Source: https://docs.vapor.codes/deploy/fly

Configure the release_command in fly.toml to execute database migrations automatically before the application starts.

```toml
[deploy]
 release_command = "migrate -y"
```

--------------------------------

### Start Scheduled Jobs In-Process

Source: https://docs.vapor.codes/advanced/queues

Enable scheduled job execution within the current application process.

```swift
try app.queues.startScheduledJobs()
```

--------------------------------

### Initialize a query builder

Source: https://docs.vapor.codes/fluent/query

Shows how to instantiate a query builder from a database object.

```swift
// Also creates a query builder.  
database.query(Planet.self)
```

--------------------------------

### Login Form HTML

Source: https://docs.vapor.codes/security/authentication

Example HTML form structure for submitting credentials to the login route.

```html
<form method="POST" action="/login">
    <label for="username">Username</label>
    <input type="text" id="username" placeholder="Username" name="username" autocomplete="username" required autofocus>
    <label for="password">Password</label>
    <input type="password" id="password" placeholder="Password" name="password" autocomplete="current-password" required>
    <input type="submit" value="Sign In">     
</form>
```

--------------------------------

### HTTP request to set session data

Source: https://docs.vapor.codes/advanced/sessions

Example request to trigger the session initialization route.

```http
GET /set/vapor HTTP/1.1  
content-length: 0
```

--------------------------------

### Example HTTP POST Request

Source: https://docs.vapor.codes/basics/content

A sample HTTP request demonstrating the use of the content-type header for JSON data.

```http
POST /greeting HTTP/1.1  
content-type: application/json  
content-length: 18  
   
{"hello": "world"}
```

--------------------------------

### Create and Configure User

Source: https://docs.vapor.codes/deploy/digital-ocean

Create a new user, grant sudo privileges, and migrate SSH keys.

```bash
adduser vapor
```

```bash
usermod -aG sudo vapor
```

```bash
rsync --archive --chown=vapor:vapor ~/.ssh /home/vapor
```

--------------------------------

### Build Vapor Toolbox from Source

Source: https://docs.vapor.codes/install/linux

Clone the repository and build the Vapor Toolbox using the provided Makefile.

```bash
git clone https://github.com/vapor/toolbox.git
cd toolbox
git checkout <desired version>
make install
```

--------------------------------

### Configure Databases and Migrations

Source: https://docs.vapor.codes/upgrading

Databases and migrations are now configured directly on the application instance.

```swift
try app.databases.use(.postgres(url: "postgres://..."), as: .psql)
```

```swift
app.migrations.use(CreatePlanet(), on: .psql)
```

--------------------------------

### Server startup log

Source: https://docs.vapor.codes/getting-started/hello-world

The console output indicating the server is successfully running locally.

```text
[ INFO ] Server starting on http://127.0.0.1:8080
```

--------------------------------

### Install Heroku CLI via Homebrew

Source: https://docs.vapor.codes/deploy/heroku

Use this command to install the Heroku CLI tool on macOS systems using Homebrew.

```bash
brew tap heroku/brew && brew install heroku
```

--------------------------------

### Initialize Application with withApp

Source: https://docs.vapor.codes/advanced/testing

Use the withApp helper to encapsulate the lifecycle management of an Application instance during tests.

```swift
@Test func someTest() async throws {   
    try await withApp(configure: configure) { app in  
        // your actual test  
    }  
}
```

--------------------------------

### Fetch relation values with get

Source: https://docs.vapor.codes/fluent/relations

Use the get method to retrieve related models, either via a future or using Swift concurrency.

```swift
// Fetches all of the sun's planets.  
sun.$planets.get(on: database).map { planets in  
    print(planets)  
}  
   
// Or  
   
let planets = try await sun.$planets.get(on: database)  
print(planets)
```

--------------------------------

### Validation Error Response

Source: https://docs.vapor.codes/basics/validation

Example output when validation fails.

```text
email is not a valid email address
```

--------------------------------

### Update main.swift structure

Source: https://docs.vapor.codes/upgrading

The new main.swift format initializes the Application instance and bootstraps the logging system.

```swift
import App  
import Vapor  
   
var env = try Environment.detect()  
try LoggingSystem.bootstrap(from: &env)  
let app = Application(env)  
defer { app.shutdown() }  
try configure(app)  
try app.run()
```

--------------------------------

### Model field change

Source: https://docs.vapor.codes/fluent/schema

Example of renaming a field in a model definition.

```swift
- @Field(key: "name")  
- var name: String  
+ @Field(key: "first_name")  
+ var firstName: String  
+  
+ @Field(key: "last_name")  
+ var lastName: String
```

--------------------------------

### Create Swift Version File

Source: https://docs.vapor.codes/deploy/heroku

Create a .swift-version file to specify the required Swift version for the buildpack.

```bash
echo "5.8.1" > .swift-version
```

--------------------------------

### Dynamic Request and Response

Source: https://docs.vapor.codes/basics/routing

An example of a dynamic request and its corresponding response.

```http
| GET /hello/swift HTTP/1.1  
---|---  
| content-length: 0
```

```http
| HTTP/1.1 200 OK  
---|---  
| content-length: 13  
| content-type: text/plain; charset=utf-8  
|    
| Hello, swift!
```

--------------------------------

### Manage Nginx Service

Source: https://docs.vapor.codes/deploy/nginx

Commands to stop, start, or restart the Nginx service.

```bash
| sudo service nginx stop  
---|---  
| sudo service nginx start  
| sudo service nginx restart
```

--------------------------------

### Create a Basic Test Case

Source: https://docs.vapor.codes/advanced/testing

Import XCTVapor and extend XCTestCase to define test methods.

```swift
import XCTVapor  
   
final class MyTests: XCTestCase {  
    func testStub() throws {  
        // Test here.  
    }  
}
```

--------------------------------

### View Default Commands

Source: https://docs.vapor.codes/advanced/commands

Use the --help flag to list available commands or inspect specific command requirements.

```bash
swift run App --help
```

```bash
swift run App serve --help
```

--------------------------------

### Create and attach a Postgres database

Source: https://docs.vapor.codes/deploy/fly

Commands to provision a new Postgres app on Fly and link it to your existing Vapor project.

```bash
fly pg create
```

```bash
fly pg attach name-of-your-postgres-app
```

--------------------------------

### Configure Testing Methods

Source: https://docs.vapor.codes/advanced/testing

Choose between in-memory programmatic testing or running a live HTTP server for tests.

```swift
// Use programmatic testing.  
app.testing(method: .inMemory).test(...)  
   
// Run tests through a live HTTP server.  
app.testing(method: .running).test(...)
```

```swift
app.testing(method: .running(port: 8123)).test(...)
```

--------------------------------

### Example HTTP Response

Source: https://docs.vapor.codes/basics/routing

The HTTP response returned by the registered route handler.

```http
| HTTP/1.1 200 OK  
---|---  
| content-length: 13  
| content-type: text/plain; charset=utf-8  
|    
| Hello, vapor!
```

--------------------------------

### Navigate to project directory

Source: https://docs.vapor.codes/getting-started/hello-world

Changes the current working directory to the newly created project folder.

```bash
cd hello
```

--------------------------------

### Configure database connection in Swift

Source: https://docs.vapor.codes/deploy/fly

Retrieve the DATABASE_URL environment variable provided by Fly to initialize the Postgres database in Vapor.

```swift
if let databaseURL = Environment.get("DATABASE_URL") {  
    try app.databases.use(.postgres(url: databaseURL), as: .psql)  
} else {  
    // Handle missing DATABASE_URL here...  
    //  
    // Alternatively, you could also set a different config   
    // depending on wether app.environment is set to to   
    // `.development` or `.production`  
}
```

--------------------------------

### Multiple Validation Errors

Source: https://docs.vapor.codes/basics/validation

Example output when multiple fields fail validation.

```text
age is less than minimum of 13, email is not a valid email address
```

--------------------------------

### Example Invalid Request

Source: https://docs.vapor.codes/basics/validation

HTTP request payload that triggers a validation error.

```http
POST /users HTTP/1.1  
Content-Length: 67  
Content-Type: application/json  
   
{  
    "age": 4,  
    "email": "foo",  
    "favoriteColor": "green",  
    "name": "Foo",  
    "username": "foo"  
}
```

--------------------------------

### Run Migration Commands

Source: https://docs.vapor.codes/fluent/migration

Execute database migrations via the command line.

```bash
swift run App migrate
```

```bash
swift run App migrate --revert
```

```bash
swift run App serve --auto-migrate
```

--------------------------------

### Open project in Xcode

Source: https://docs.vapor.codes/getting-started/hello-world

Opens the Swift package in Xcode to begin dependency resolution and development.

```bash
open Package.swift
```

--------------------------------

### Bearer Authentication Request Format

Source: https://docs.vapor.codes/security/authentication

Example of the HTTP request structure for Bearer authentication.

```http
| GET /me HTTP/1.1  
---|---  
| Authorization: Bearer foo  
Copy
```

--------------------------------

### Initialize a Test Suite

Source: https://docs.vapor.codes/advanced/testing

Import the necessary modules and define a test suite using the @Suite attribute.

```swift
@testable import App  
import VaporTesting  
import Testing  
   
@Suite("App Tests")  
struct AppTests {  
    @Test("Test Stub")  
    func stub() async throws {  
        // Test here.  
    }  
}
```

--------------------------------

### Dotenv file format

Source: https://docs.vapor.codes/basics/environment

Define key-value pairs in a .env file to be loaded automatically at boot.

```text
FOO=BAR
```

--------------------------------

### Basic Authentication Header Format

Source: https://docs.vapor.codes/security/authentication

Example of the Authorization header structure for Basic authentication.

```http
GET /me HTTP/1.1  
Authorization: Basic dGVzdDpzZWNyZXQ=
```

--------------------------------

### Launch Vapor App on Fly

Source: https://docs.vapor.codes/deploy/fly

Initializes the Fly.io configuration for the current directory.

```bash
fly launch
```

--------------------------------

### Build and run project on Linux

Source: https://docs.vapor.codes/getting-started/hello-world

Compiles and executes the Vapor application from the terminal.

```bash
swift run
```

--------------------------------

### Example HTTP Response

Source: https://docs.vapor.codes/basics/content

The resulting HTTP response after successfully decoding the query string.

```http
| HTTP/1.1 200 OK  
---|---  
| content-length: 12  
|    
| Hello, Vapor  
Copy
```

--------------------------------

### URL-Encoded Form Request

Source: https://docs.vapor.codes/basics/content

An example of an HTTP request using the application/x-www-form-urlencoded content type.

```http
POST /greeting HTTP/1.1  
content-type: application/x-www-form-urlencoded  
content-length: 11  
   
hello=world
```

--------------------------------

### Run Migrations

Source: https://docs.vapor.codes/fluent/overview

Register migrations and execute them to update the database schema.

```swift
| app.migrations.add(CreateTodo())  
---|---  
| try app.autoMigrate().wait()  
| // or  
| try await app.autoMigrate()  
```

--------------------------------

### Configuring the HTTP Client

Source: https://docs.vapor.codes/basics/client

Configure the underlying HTTP client via the application before its first use.

```swift
// Disable automatic redirect following.  
app.http.client.configuration.redirectConfiguration = .disallow
```

--------------------------------

### Start the scheduler worker

Source: https://docs.vapor.codes/advanced/queues

Command to initiate the worker process responsible for executing scheduled jobs.

```bash
swift run App queues --scheduled
```

--------------------------------

### Middleware Execution Order

Source: https://docs.vapor.codes/advanced/middleware

Demonstrates how global and route-specific middleware are chained together.

```swift
app.middleware.use(MiddlewareA())
app.middleware.use(MiddlewareB())

app.group(MiddlewareC()) {
    $0.get("hello") { req in
        "Hello, middleware."
    }
}
```

--------------------------------

### Start In-Process Queue Workers

Source: https://docs.vapor.codes/advanced/queues

Execute queue workers within the main application process.

```swift
try app.queues.startInProcessJobs(on: .default)
```

--------------------------------

### Initialize and Add RSA Keys

Source: https://docs.vapor.codes/security/jwt

Configures RSA keys using PEM format or component initialization, noting that RSA keys are gated under the Insecure namespace.

```swift
let rsaPublicKey = """
-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC0cOtPjzABybjzm3fCg1aCYwnx
PmjXpbCkecAWLj/CcDWEcuTZkYDiSG0zgglbbbhcV0vJQDWSv60tnlA3cjSYutAv
7FPo5Cq8FkvrdDzeacwRSxYuIq1LtYnd6I30qNaNthntjvbqyMmBulJ1mzLI+Xg/
aX4rbSL49Z3dAQn8vQIDAQAB
-----END PUBLIC KEY-----
"""
   
// Initialize an RSA key with public pem.
let key = try Insecure.RSA.PublicKey(pem: rsaPublicKey)
```

```swift
// Initialize an RSA private key with components.
let key = try Insecure.RSA.PrivateKey(
    modulus: modulus, 
    exponent: publicExponent, 
    privateExponent: privateExponent
)
```

```swift
await app.jwt.keys.add(rsa: key, digestAlgorithm: .sha256)
```

--------------------------------

### HTTP request with Bearer token

Source: https://docs.vapor.codes/security/jwt

Example of sending a JWT in the Authorization header of an HTTP request.

```http
GET /me HTTP/1.1  
authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ2YXBvciIsImV4cCI6NjQwOTIyMTEyMDAsImFkbWluIjp0cnVlfQ.lS5lpwfRNSZDvpGQk6x5JI1g40gkYCOWqbc3J_ghowo
```

--------------------------------

### Initialize and Manage Git Repository

Source: https://docs.vapor.codes/deploy/heroku

Commands to initialize a Git repository, check the current branch, and switch branches.

```bash
git init
```

```bash
git branch
```

```bash
| * main  
---|---  
|   commander  
|   other-branches
```

```bash
git checkout main
```

--------------------------------

### JSON Representation of Parent Relation

Source: https://docs.vapor.codes/fluent/relations

Example of how a parent relation is structured in JSON during encoding or decoding.

```json
{
    "id": "A616B398-A963-4EC7-9D1D-B1AA8A6F1107",
    "star": {
        "id": "A1B2C3D4-1234-5678-90AB-CDEF12345678"
    }
}
```

--------------------------------

### Enable FileMiddleware

Source: https://docs.vapor.codes/getting-started/folder-structure

Register FileMiddleware in configure.swift to serve static assets from the Public directory.

```swift
| // Serves files from `Public/` directory  
---|---  
| let fileMiddleware = FileMiddleware(  
|     publicDirectory: app.directory.publicDirectory  
| )  
| app.middleware.use(fileMiddleware)
```

--------------------------------

### Configure PostgreSQL Driver

Source: https://docs.vapor.codes/fluent/overview

Add PostgreSQL dependencies and configure the connection using credentials or a connection string.

```swift
.package(url: "https://github.com/vapor/fluent-postgres-driver.git", from: "2.0.0")
```

```swift
.product(name: "FluentPostgresDriver", package: "fluent-postgres-driver")
```

```swift
| import Fluent  
---|---  
| import FluentPostgresDriver  
|    
| app.databases.use(  
|     .postgres(  
|         configuration: .init(  
|             hostname: "localhost",  
|             username: "vapor",  
|             password: "vapor",  
|             database: "vapor",  
|             tls: .disable  
|         )  
|     ),  
|     as: .psql  
| )  
```

```swift
try app.databases.use(.postgres(url: "<connection string>"), as: .psql)
```

--------------------------------

### Connect via SSH

Source: https://docs.vapor.codes/deploy/fly

Establish an SSH connection to a running app instance.

```bash
fly ssh console -s
```

--------------------------------

### Example signed JWT response

Source: https://docs.vapor.codes/security/jwt

The expected JSON response format containing the signed JWT string.

```json
{
   "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ2YXBvciIsImV4cCI6NjQwOTIyMTEyMDAsImFkbWluIjp0cnVlfQ.lS5lpwfRNSZDvpGQk6x5JI1g40gkYCOWqbc3J_ghowo"
}
```

--------------------------------

### List Docker Images

Source: https://docs.vapor.codes/deploy/docker

Displays all available Docker images on the system.

```bash
docker image ls
```

--------------------------------

### Implement a Hello tag using parameters

Source: https://docs.vapor.codes/leaf/custom-tags

A tag that renders HTML using a parameter passed directly in the template.

```swift
enum HelloTagError: Error {  
    case missingNameParameter  
}  
   
struct HelloTag: UnsafeUnescapedLeafTag {  
    func render(_ ctx: LeafContext) throws -> LeafData {  
        guard let name = ctx.parameters[0].string else {  
            throw HelloTagError.missingNameParameter  
        }  
   
        return LeafData.string("<p>Hello \(name)</p>")  
    }  
}
```

```leaf
#hello("John")
```

--------------------------------

### Usage of custom tag in Leaf template

Source: https://docs.vapor.codes/leaf/custom-tags

Example of invoking the custom tag within a template file.

```leaf
The time is #now()
```

--------------------------------

### Configure Fluent Session Driver

Source: https://docs.vapor.codes/advanced/sessions

Sets up the Fluent driver for session storage, either using the default database or a specific one.

```swift
import Fluent

app.sessions.use(.fluent)
```

```swift
app.sessions.use(.fluent(.sqlite))
```

--------------------------------

### Define a Content Type for Validation

Source: https://docs.vapor.codes/basics/validation

Example of a struct conforming to Content for use in a POST route handler.

```swift
enum Color: String, Codable {  
    case red, blue, green  
}  
   
struct CreateUser: Content {  
    var name: String  
    var username: String  
    var age: Int  
    var email: String  
    var favoriteColor: Color?  
}  
   
app.post("users") { req -> CreateUser in  
    let user = try req.content.decode(CreateUser.self)  
    // Do something with user.  
    return user  
}
```

--------------------------------

### Validation API Error Message

Source: https://docs.vapor.codes/basics/validation

Example of a human-readable error message generated using the Validation API.

```text
favoriteColor is not red, blue, or green
```

--------------------------------

### Initialize and Add ECDSA Keys

Source: https://docs.vapor.codes/security/jwt

Demonstrates initializing ECDSA keys from PEM strings or generating random keys, followed by adding them to the keychain.

```swift
let ecdsaPublicKey = """
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE2adMrdG7aUfZH57aeKFFM01dPnkx
C18ScRb4Z6poMBgJtYlVtd9ly63URv57ZW0Ncs1LiZB7WATb3svu+1c7HQ==
-----END PUBLIC KEY-----
"""
   
// Initialize an ECDSA key with public PEM.
let key = try ES256PublicKey(pem: ecdsaPublicKey)
```

```swift
let key = ES256PrivateKey()
```

```swift
await app.jwt.keys.add(ecdsa: key)
```

--------------------------------

### Standard Codable Error Message

Source: https://docs.vapor.codes/basics/validation

Example of a default error message generated when decoding fails for an enum.

```text
Cannot initialize Color from invalid String value purple for key favoriteColor
```

--------------------------------

### List All Containers

Source: https://docs.vapor.codes/deploy/docker

Displays both running and stopped containers.

```bash
docker container ls -a
```

--------------------------------

### Implement Login Routes

Source: https://docs.vapor.codes/security/authentication

Create routes to sign and return JWTs, either using an authenticator or manual credential validation.

```swift
let passwordProtected = app.grouped(User.authenticator(), User.guardMiddleware())
passwordProtected.post("login") { req async throws -> ClientTokenResponse in
    let user = try req.auth.require(User.self)
    let payload = try SessionToken(with: user)
    return ClientTokenResponse(token: try await req.jwt.sign(payload))
}
```

```swift
app.post("login") { req async throws -> ClientTokenResponse in
    // Validate provided credential for user
    // Get userId for provided user
    let payload = try SessionToken(userId: userId)
    return ClientTokenResponse(token: try await req.jwt.sign(payload))
}
```

--------------------------------

### Using Custom HTML Type in Routes

Source: https://docs.vapor.codes/basics/content

Example of returning the custom HTML type from a route handler.

```swift
| app.get { _ in  
---|---  
|   HTML(value: """  
|   <html>  
|     <body>  
|       <h1>Hello, World!</h1>  
|     </body>  
|   </html>  
|   """)  
| }
```

--------------------------------

### Initialize and Add EdDSA Keys

Source: https://docs.vapor.codes/security/jwt

Shows how to initialize EdDSA keys using coordinate strings or by generating random keys, then adding them to the keychain.

```swift
let publicKey = try EdDSA.PublicKey(x: "0ZcEvMCSYqSwR8XIkxOoaYjRQSAO8frTMSCpNbUl4lE", curve: .ed25519)
   
let privateKey = try EdDSA.PrivateKey(d: "d1H3/dcg0V3XyAuZW2TE5Z3rhY20M+4YAfYu/HUQd8w=", curve: .ed25519)
```

```swift
let key = EdDSA.PrivateKey(curve: .ed25519)
```

```swift
await app.jwt.keys.add(eddsa: key)
```

--------------------------------

### Deploy and Scale Application

Source: https://docs.vapor.codes/deploy/heroku

Commands to push the code to Heroku and scale the web process.

```bash
git push heroku main
```

```bash
heroku ps:scale web=1
```

--------------------------------

### Validate Nginx Installation

Source: https://docs.vapor.codes/deploy/nginx

Access the server via a web browser to verify the Nginx default page.

```text
http://server_domain_name_or_IP
```

--------------------------------

### Test Authentication Requests

Source: https://docs.vapor.codes/security/authentication

Example HTTP requests for testing bearer token authentication and session cookie persistence.

```http
GET /me HTTP/1.1  
authorization: Bearer test
```

```http
GET /me HTTP/1.1  
cookie: vapor_session=123
```

--------------------------------

### Create a basic schema

Source: https://docs.vapor.codes/fluent/schema

Initializes a new table with an ID and a required string field.

```swift
try await database.schema("planets")  
    .id()  
    .field("name", .string, .required)  
    .create()
```

--------------------------------

### Test Authenticated Endpoint

Source: https://docs.vapor.codes/security/authentication

Example HTTP request using the Bearer authentication header to access a protected route.

```http
GET /me HTTP/1.1
Authorization: Bearer <token>
```

--------------------------------

### Copying template to environment file

Source: https://docs.vapor.codes/basics/environment

Create environment-specific files from a template.

```bash
cp .env .env.development  
vim .env.development
```

--------------------------------

### Basic Authentication Request

Source: https://docs.vapor.codes/security/authentication

Example of an HTTP POST request using the Basic authentication header to authenticate a user.

```http
POST /login HTTP/1.1  
Authorization: Basic dGVzdEB2YXBvci5jb2RlczpzZWNyZXQ0Mg==
```

--------------------------------

### Update Package.swift for Vapor 4

Source: https://docs.vapor.codes/upgrading

Example of the diff required to update dependencies, platforms, and target definitions in Package.swift.

```swift
| -// swift-tools-version:4.0  
---|---  
| +// swift-tools-version:5.2  
|  import PackageDescription  
|    
|  let package = Package(  
|      name: "api",  
| +    platforms: [  
| +        .macOS(.v10_15),  
| +    ],  
|      dependencies: [  
| -        .package(url: "https://github.com/vapor/fluent-postgresql.git", from: "1.0.0"),  
| +        .package(url: "https://github.com/vapor/fluent.git", from: "4.0.0"),  
| +        .package(url: "https://github.com/vapor/fluent-postgres-driver.git", from: "2.0.0"),  
| -        .package(url: "https://github.com/vapor/jwt.git", from: "3.0.0"),  
| +        .package(url: "https://github.com/vapor/jwt.git", from: "4.0.0"),  
| -        .package(url: "https://github.com/vapor/vapor.git", from: "3.0.0"),  
| +        .package(url: "https://github.com/vapor/vapor.git", from: "4.3.0"),  
|      ],  
|      targets: [  
|          .target(name: "App", dependencies: [  
| -            "FluentPostgreSQL",   
| +            .product(name: "Fluent", package: "fluent"),  
| +            .product(name: "FluentPostgresDriver", package: "fluent-postgres-driver"),  
| -            "Vapor",   
| +            .product(name: "Vapor", package: "vapor"),  
| -            "JWT",   
| +            .product(name: "JWT", package: "jwt"),  
|          ]),  
| -        .target(name: "Run", dependencies: ["App"]),  
| -        .testTarget(name: "AppTests", dependencies: ["App"])  
| +        .target(name: "Run", dependencies: [  
| +            .target(name: "App"),  
| +        ]),  
| +        .testTarget(name: "AppTests", dependencies: [  
| +            .target(name: "App"),  
| +        ])  
|      ]  
|  )
```

--------------------------------

### Update Migration Methods

Source: https://docs.vapor.codes/upgrading

The prepare and revert methods are no longer static and now accept a Database instance.

```swift
| - static func prepare(on conn: <#Database#>Connection) -> Future<Void> {  
---|---  
| + func prepare(on database: Database) -> EventLoopFuture<Void>
```

--------------------------------

### HTTP Request and Response for Star Creation

Source: https://docs.vapor.codes/fluent/overview

Example of the JSON payload for creating a star and the expected server response.

```http
POST /stars HTTP/1.1  
content-length: 36  
content-type: application/json  
   
{  
    "name": "Sun",  
    "galaxy": {  
        "id": ...  
    }  
}
```

```json
{  
    "id": ...,  
    "name": "Sun",  
    "galaxy": {  
        "id": ...  
    }  
}
```

--------------------------------

### Built-in Leaf Tags

Source: https://docs.vapor.codes/leaf/overview

Examples of various built-in Leaf tags for template extension, exporting, importing, and iteration.

```leaf
| #(variable)  
---|---  
| #extend("template"): I'm added to a base template! #endextend  
| #export("title"): Welcome to Vapor #endexport  
| #import("body")  
| #count(friends)  
| #for(friend in friends): <li>#(friend.name)</li> #endfor
```

--------------------------------

### Configure Server Hostname

Source: https://docs.vapor.codes/advanced/server

Sets the hostname the server listens on.

```swift
app.http.server.configuration.hostname = "dev.local"
```

```bash
swift run App serve --hostname dev.local
```

--------------------------------

### Get an optional authenticated user

Source: https://docs.vapor.codes/security/authentication

Use req.auth.get to retrieve the user without throwing an error if authentication is missing.

```swift
let user = req.auth.get(User.self)
print(user?.name) // String?
```

--------------------------------

### Configure Database in configure.swift

Source: https://docs.vapor.codes/fluent/overview

Register your database driver with the application using app.databases.use.

```swift
| import Fluent  
---|---  
| import Fluent<db>Driver  
|    
| app.databases.use(<db config>, as: <identifier>)  
```

--------------------------------

### Configure Queues Redis Driver

Source: https://docs.vapor.codes/advanced/queues

Initialize the Redis driver within the configure.swift file.

```swift
| import QueuesRedisDriver  
---|---  
|    
| try app.queues.use(.redis(url: "redis://127.0.0.1:6379"))
```

--------------------------------

### Create a new record

Source: https://docs.vapor.codes/fluent/overview

Demonstrates creating a model from request content using both EventLoopFuture and async/await patterns.

```swift
app.post("galaxies") { req -> EventLoopFuture<Galaxy> in  
    let galaxy = try req.content.decode(Galaxy.self)  
    return galaxy.create(on: req.db)
        .map { galaxy }  
}
```

```swift
app.post("galaxies") { req async throws -> Galaxy in  
    let galaxy = try req.content.decode(Galaxy.self)  
    try await galaxy.create(on: req.db)  
    return galaxy  
}
```

--------------------------------

### Example JSON response with eager loaded stars

Source: https://docs.vapor.codes/fluent/overview

Shows the expected structure of a response containing nested related models.

```json
[
    {
        "id": ...,
        "name": "Milky Way",
        "stars": [
            {
                "id": ...,
                "name": "Sun",
                "galaxy": {
                    "id": ...
                }
            }
        ]
    }
]
```

--------------------------------

### Configure Database for Testing

Source: https://docs.vapor.codes/advanced/testing

Use the application environment to switch to an in-memory database during testing to avoid modifying production data.

```swift
public func configure(_ app: Application) async throws {  
    // All other configurations...  
   
    if app.environment == .testing {  
        app.databases.use(.sqlite(.memory), as: .sqlite)  
    } else {  
        app.databases.use(.sqlite(.file("db.sqlite")), as: .sqlite)  
    }  
}
```

--------------------------------

### Define a Fluent Model

Source: https://docs.vapor.codes/fluent/overview

A complete example of a model class conforming to the Model protocol with schema, ID, and field definitions.

```swift
final class Galaxy: Model {  
    // Name of the table or collection.  
    static let schema = "galaxies"  
   
    // Unique identifier for this Galaxy.  
    @ID(key: .id)  
    var id: UUID?  
   
    // The Galaxy's name.  
    @Field(key: "name")  
    var name: String  
   
    // Creates a new, empty Galaxy.  
    init() { }  
   
    // Creates a new Galaxy with all properties set.  
    init(id: UUID? = nil, name: String) {  
        self.id = id  
        self.name = name  
    }  
}
```

--------------------------------

### Registering a Route with app.on

Source: https://docs.vapor.codes/basics/routing

An alternative syntax for registering routes using the HTTP method explicitly.

```swift
app.on(.GET, "hello", "vapor") { ... }
```

--------------------------------

### Implement RedisSessionsDelegate for Hash Storage

Source: https://docs.vapor.codes/redis/sessions

Example implementation of storing session data as a Redis Hash instead of a JSON string.

```swift
func redis<Client: RedisClient>(  
    _ client: Client,  
    store data: SessionData,  
    with key: RedisKey  
) -> EventLoopFuture<Void> {  
    // stores each data field as a separate hash field  
    return client.hmset(data.snapshot, in: key)  
}  
func redis<Client: RedisClient>(  
    _ client: Client,  
    fetchDataFor key: RedisKey  
) -> EventLoopFuture<SessionData?> {  
    return client  
        .hgetall(from: key)  
        .map { hash in  
            // hash is [String: RESPValue] so we need to try and unwrap the  
            // value as a string and store each value in the data container  
            return hash.reduce(into: SessionData()) { result, next in  
                guard let value = next.value.string else { return }  
                result[next.key] = value  
            }  
        }  
}
```

--------------------------------

### Configure Redis Session Driver

Source: https://docs.vapor.codes/advanced/sessions

Sets up the Redis driver for session storage using the default configuration.

```swift
import Redis

app.sessions.use(.redis)
```

--------------------------------

### Accessing process environment variables

Source: https://docs.vapor.codes/basics/environment

Retrieve environment variables using the string-based get API or dynamic member lookup.

```swift
let foo = Environment.get("FOO")  
print(foo) // String?
```

```swift
let foo = Environment.process.FOO  
print(foo) // String?
```

--------------------------------

### Create and complete a promise

Source: https://docs.vapor.codes/basics/async

Demonstrates initializing a promise on an event loop and completing it with success or failure.

```swift
let eventLoop: EventLoop   
   
// Create a new promise for some string.  
let promiseString = eventLoop.makePromise(of: String.self)  
print(promiseString) // EventLoopPromise<String>  
print(promiseString.futureResult) // EventLoopFuture<String>  
   
// Completes the associated future.  
promiseString.succeed("Hello")  
   
// Fails the associated future.  
promiseString.fail(...)
```

--------------------------------

### Configure AsyncTestQueuesDriver for XCTest

Source: https://docs.vapor.codes/advanced/queues

Overrides the default queue driver with the async test driver within an XCTestCase setup method.

```swift
final class UserCreationServiceTests: XCTestCase {  
    var app: Application!  
   
    override func setUp() async throws {  
        self.app = try await Application.make(.testing)  
        try await configure(app)  
   
        // Override the driver being used for testing  
        app.queues.use(.asyncTest)  
    }  
   
    override func tearDown() async throws {  
        try await self.app.asyncShutdown()  
        self.app = nil  
    }  
}
```
Tokens:
Raw