Getting Started with Hummingbird | Documentation

Original URL: https://docs.hummingbird.codes/2.0/documentation/hummingbird/gettingstarted/

Title: Getting Started with Hummingbird | Documentation

URL Source: http://docs.hummingbird.codes/2.0/documentation/hummingbird/gettingstarted/

Markdown Content:

Getting Started with Hummingbird | Documentation

Skip Navigation

Documentation

Open Menu

• Language: Swift

Documentation

Hummingbird

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

1 of 72 symbols inside

Application

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

2 of 72 symbols inside containing 20 symbolsApplication

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

3 of 72 symbols inside containing 16 symbolsApplicationProtocol

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

38 of 72 symbols inside containing 2 symbolsRequestDecoder

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

37 of 72 symbols inside

Encoding/Decoding

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

36 of 72 symbols inside containing 2 symbolsRemoteAddressRequestContext

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

35 of 72 symbols inside containing 5 symbolsCoreRequestContextStorage

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

34 of 72 symbols inside containing 4 symbolsChildRequestContext

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

33 of 72 symbols inside containing 6 symbolsBasicRequestContext

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

32 of 72 symbols inside containing 5 symbolsApplicationRequestContextSource

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

31 of 72 symbols inside containing 2 symbolsRequestContextSource

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

30 of 72 symbols inside containing 12 symbolsRequestContext

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

29 of 72 symbols inside

Request context

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

28 of 72 symbols inside containing 4 symbolsCookies

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

27 of 72 symbols inside containing 22 symbolsCookie

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

26 of 72 symbols inside containing 9 symbolsEditedResponse

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

25 of 72 symbols inside containing 6 symbolsResponseBodyWriter

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

24 of 72 symbols inside containing 17 symbolsResponse

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

23 of 72 symbols inside containing 7 symbolsCacheControl

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

22 of 72 symbols inside containing 107 symbolsMediaType

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

21 of 72 symbols inside Parameters

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

20 of 72 symbols inside containing 18 symbolsRequest

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

19 of 72 symbols inside

Request/Response

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

18 of 72 symbols inside containing 4 symbolsRequestID

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

17 of 72 symbols inside containing 18 symbolsRouterPath

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

16 of 72 symbols inside containing 4 symbolsEndpointPath

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

15 of 72 symbols inside containing 2 symbolsRouterResponder

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

14 of 72 symbols inside containing 4 symbolsCallbackResponder

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

13 of 72 symbols inside containing 4 symbolsHTTPResponderBuilder

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

12 of 72 symbols inside containing 4 symbolsHTTPResponder

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

11 of 72 symbols inside containing 11 symbolsRouterOptions

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

10 of 72 symbols inside containing 18 symbolsRouterMethods

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

9 of 72 symbols inside containing 7 symbolsRouteCollection

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

8 of 72 symbols inside containing 5 symbolsRouterGroup

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

7 of 72 symbols inside containing 14 symbolsRouter

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

6 of 72 symbols inside

Router

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

5 of 72 symbols inside containing 5 symbolsEventLoopGroupProvider

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

4 of 72 symbols inside containing 11 symbolsApplicationConfiguration

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

3 of 72 symbols inside containing 16 symbolsApplicationProtocol

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

2 of 72 symbols inside containing 20 symbolsApplication

To navigate the symbols, press Up Arrow, Down Arrow, Left Arrow or Right Arrow

1 of 72 symbols inside

Application

72 items were found. Tab back to navigate through them.

/

Navigator is ready

• Hummingbird Documentation
• Getting Started with Hummingbird

Article

Getting Started with Hummingbird

Create a new Hummingbird project from the project template.

Overview

The Hummingbird project provides multiple entry points for getting started.

1. Create your own project that uses Hummingbird from a starting template to jump right in.

2. For a walk-through, explore and follow along the Build a Todos Application tutorial.

3. Take some time to explore the Hummingbird Examples, individual projects that use common patterns.

Using the project template

Clone the starting template to your local machine:

git clone https://github.com/hummingbird-project/template

Run the configure script provided to create a new folder and project inside:

./template/configure.sh MyNewProject

Change into the new project directory:

cd MyNewProject

Then run your app:

swift run

Next Steps

Follow our TODO’s tutorial to get started with the framework: Build a Todos application. or explore the Hummingbird Examples for demonstrations of how to use the framework.

See Also

Getting Started

Build a Todos application.

A tutorial showing you how to build a simple Todos application that allows you to store, access, edit and delete Todos in a database, using Hummingbird and PostgresNIO.

• Getting Started with Hummingbird
• Overview
• Using the project template
• Next Steps
• See Also

Current page is Getting Started with Hummingbird

Select a color scheme preference

Light

Dark

Auto