https://github.com/mochidev/hostrouter

A Vapor middleware for including domains in routing
https://github.com/mochidev/hostrouter

serverside-swift swift vapor

Last synced: about 1 month ago
JSON representation

A Vapor middleware for including domains in routing

• Host: GitHub
• URL: https://github.com/mochidev/hostrouter
• Owner: mochidev
• License: mit
• Created: 2024-01-06T11:12:14.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-11T11:46:28.000Z (12 months ago)
• Last Synced: 2024-10-31T12:41:07.467Z (about 2 months ago)
• Topics: serverside-swift, swift, vapor
• Language: Swift
• Homepage:
• Size: 12.7 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HostRouter



    

        

    

    

        

    

    

        

    



A [Vapor](https://vapor.codes) middleware for including the domain in routing.

## Quick Links

- [Documentation](https://swiftpackageindex.com/mochidev/HostRouter/documentation)

- [Updates on Mastodon](https://mastodon.social/tags/HostRouter)

## Installation

Add `HostRouter` as a dependency in your `Package.swift` file to start using it. Then, add `import HostRouter` to any file you wish to use the library in.

Please check the [releases](https://github.com/mochidev/HostRouter/releases) for recommended versions.

```swift

dependencies: [

    .package(url: "https://github.com/vapor/vapor.git", from: "4.90.0"),

    .package(url: "https://github.com/mochidev/HostRouter.git", .upToNextMinor(from: "0.2.0")),

],

...

targets: [

    .executableTarget(

        name: "MyPackage",

        dependencies: [

            .product(name: "Vapor", package: "vapor")

            .product(name: "HostRouter", package: "HostRouter")

        ]

    )

]

```

## What is `HostRouter`?

`HostRouter` extends Vapor's routing capabilities by allowing you to include routes for the host domain along with the resource. This makes it easy to partition a domain running on a single server with dynamic routing for different users or services.

`Host Router` was heavily inspired by by a [post](https://github.com/vapor/vapor/issues/2745#issuecomment-1450795410) by @andreasley on the Vapor repo, along with Vapor's own [`DefaultResponder`](https://github.com/vapor/vapor/blob/main/Sources/Vapor/Responder/DefaultResponder.swift).

## Contributing

Contribution is welcome! Please take a look at the issues already available, or start a new discussion to propose a new feature. Although guarantees can't be made regarding feature requests, PRs that fit within the goals of the project and that have been discussed beforehand are more than welcome!

Please make sure that all submissions have clean commit histories, are well documented, and thoroughly tested. **Please rebase your PR** before submission rather than merge in `main`. Linear histories are required, so merge commits in PRs will not be accepted.

## Support

To support this project, consider following [@dimitribouniol](https://mastodon.social/@dimitribouniol) on Mastodon, listening to Spencer and Dimitri on [Code Completion](https://mastodon.social/@codecompletion), or downloading Dimitri's wife Linh's app, [Not Phở](https://notpho.app/).