Ngrokit

用于 Ngrok Agent API 的 Swift API。

SwiftPM Twitter GitHub GitHub issues GitHub Workflow Status

Codecov CodeFactor Grade codebeat badge Code Climate maintainability Code Climate technical debt Code Climate issues

目录

要求

Apple 平台

Linux

安装

要使用 SPM 将 Ngrokit 集成到您的应用程序中，请在 Package.swift 文件中指定它

let package = Package(
  ...
  dependencies: [
    .package(url: "https://github.com/brightdigit/Ngrokit.git", from: "1.0.0")
  ],
  targets: [
      .target(
          name: "YourServerApp",
          dependencies: [
            .product(name: "Ngrokit", package: "Ngrokit"), ...
          ]),
      ...
  ]
)

用法

Ngrokit 是一个易于使用的 Swift 库，用于调用本地 Ngrok API 以及运行 ngrok 命令。

连接到本地 REST API

使用 NgrokClient 连接到您的本地开发服务器

let client = NgrokClient(transport: URLSession.shared)

有关使用不同传输方式的信息，请参阅 Swift OpenAPI Generator 上的客户端列表。

启动 CLI 进程

使用 NgrokProcessCLIAPI 启动 CLI 进程

let cliAPI = NgrokProcessCLIAPI(ngrokPath: "/usr/local/bin/ngrok")
let process = api.process(forHTTPPort: 100)
process.run { let error in
  print(error)
}

文档

要了解更多信息，请查看完整的文档。

许可证

此代码根据 MIT 许可证分发。 有关更多信息，请参阅 LICENSE 文件。