routing-kit:基于 Swift 的高性能 HTTP 路由项目

可用于构建 Web 框架,实现 HTTP 请求的高效路由。它是高性能前缀树节点路由器,支持动态路径参数、多种路径组件类型,构建后不可变以保证速度与安全性,还允许自定义路由逻辑。【此简介由AI生成】

Branch4Tags55

RoutingKit

Documentation Team Chat MIT License Continuous Integration Code Coverage></a>
<a href=Swift 6.1+


RoutingKit is a high-performance, trie-node router to route HTTP requests to the correct route handler. It allows for dynamic path parameters to make building web frameworks easy.

Installation

Manually add the following to your Package.swift file:

dependencies: [
    .package(url: "https://github.com/vapor/routing-kit.git", from: "5.0.0")
],
targets: [
    .target(
        name: "MyTarget",
        dependencies: [
            .product(name: "RoutingKit", package: "routing-kit"),
        ]
    ),
]

Usage

To use RoutingKit, first import the module:

import RoutingKit

Then, create a router builder instance:

let builder = TrieRouterBuilder(String.self)
// or
let builder = TrieRouterBuilder<Int>()

Next, register routes with associated handlers:

builder.register("handler1", at: ["users", ":id"])
builder.register("handler2", at: ["posts", ":postId", "comments"])

Finally, build the router and use it to route incoming paths:

let router = builder.build()
var params = Parameters()
if let handler = router.route(["users", "123"], parameters: &params) {
    print("Routed to handler: \(handler) with params: \(params)")
}

Note

To preserve both speed and safety, once you create a router using the build() method, it becomes immutable. Any further modifications require creating a new builder instance.

There's different types of path components you can use when registering routes:

  • Constant path components: e.g. "users", "posts"
  • Parameter path components: e.g. ":id", ":postId"
  • Wildcard path components: e.g. "*"
  • Partial parameter path components: e.g. ":{file-name}.{ext}"

All of these can be used simply by passing the appropriate strings to the register method.

Custom Router

You can also create your own custom router by conforming to the Router protocol. This allows you to define your own routing logic rather than using the built-in trie-based router.

Introduction

可用于构建 Web 框架,实现 HTTP 请求的高效路由。它是高性能前缀树节点路由器,支持动态路径参数、多种路径组件类型,构建后不可变以保证速度与安全性,还允许自定义路由逻辑。【此简介由AI生成】

Customize your domain