Bow OpenAPI 是一个命令行工具,用于从 OpenAPI / Swagger 规范文件生成 Swift 网络客户端。 请参考项目网站,获取关于该项目的详尽文档。
💡 自动生成用 Swift 编写的网络客户端,它基于 OpenAPI / Swagger 规范文件,支持 YAML 或 JSON 格式。
📦 提供一个Swift Package,可以通过 Swift Package Manager 使用。
🔨 与 Xcode 集成作为构建阶段的一部分,始终保持您的代码与规范同步。
💥 使用来自 Bow 的 环境效应 (Environmental Effects) 来暂停副作用,并改善它们的组合和可测试性。
✅ 增强的测试支持,无需模拟即可进行集成或端到端测试。
Bow OpenAPI 与 Unix 系统兼容。
您可以使用 Homebrew 安装 Bow OpenAPI。 它的公式尚未在主存储库中;因此,您需要先 tap 它,然后再安装。
brew tap bow-swift/bow
brew install bow-openapi
curl -s https://api.github.com/repos/bow-swift/bow-openapi/releases/latest \
| grep -oP '"tag_name": "\K(.*)(?=")' \
| xargs -I {} wget -O - https://github.com/bow-swift/bow-openapi/archive/{}.tar.gz \
| tar xz \
&& sudo make linux -C bow-openapi-*
它将安装最新的稳定版本。
Bow OpenAPI 依赖于 Java 8+
和 swagger-codegen
;两者都将从 Makefile
安装。 安装完成后,您可以在新的终端中键入 bow-openapi -h
来检查它。
您可以使用以下参数调用该工具
bow-openapi --name <NAME> --schema <YAML | JSON> --output <FOLDER>
name
是生成的 Swift Package 中模块的名称。 您将需要使用 import <NAME>
在您的代码中导入它。schema
是 OpenAPI / Swagger 规范文件的路径。 它接受 YAML 或 JSON 格式。output
是结果将保存到的文件夹。我们欢迎您的贡献! 帮助我们使 Bow OpenAPI 更好
🐛 如果您发现错误,请提交 issue。
🆕 为 Bow OpenAPI 提出新功能建议。
➡️ 打开 Pull Request 以修复问题或添加新功能。
💬 在我们的 Gitter 频道 中与我们讨论,以帮助我们塑造 Bow OpenAPI 的未来。
Copyright (C) 2020-2021 The Bow Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://apache.ac.cn/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.