Swift OpenAPI Generator Bazel rules

A wrapper over the Swift OpenAPI Generator.

Usage

For more examples, see Examples.

Here are the instructions for quickly using the generator:

1. Adding the module in your MODULE.bazel
2. Apply a rules_swift_package_manager workaround
3. Using the swift_openapi_generate rule

Adding the Module

The dependency is added by inserting these lines into MODULE.bazel:

bazel_dep(name = "swift-openapi-generator", version = "1.0.0-alpha.1")
archive_override(
    module_name = "swift-openapi-generator",
    integrity = "sha256-mKdLcKFsRxeIH57RVrVfm4t9raC/WfIYEYdZvgO8J5M=",
    strip_prefix = "bazel-swift-openapi-generator-1.0.0-alpha.1",
    urls = ["https://github.com/Dreksh/bazel-swift-openapi-generator/archive/refs/tags/v1.0.0-alpha.1.tar.gz"],
)

Check the release notes for the updated values to put into the snippet above.

Using the Rule

In the Bazel package where you want to generate the Swift code from OpenAPI specs, add these lines:

load("@swift-openapi-generator//:defs.bzl", "swift_openapi_generate")

swift_openapi_generate(
    name = "server_stub",
    spec = "openapi.yaml",
    config = "openapi-generator-config.yaml",
)

The name of the rule determines the directory where the files will be placed when it's generated. openapi.yaml is the spec to generate code for, and openapi-generator-config.yaml configures the generator (see Configuring the generator )

Updating the Version

Simply run bazel run //:update -- <version>, where the version is the tag in the Swift OpenAPI Generator repository. This will run a script that updates the files in this repo to point to a different version.

This script currently requires the following tools installed:

• bazel
• curl
• git
• swift (or Xcode for macOS)

Issues and Their Workarounds

There are some known issues which require some workarounds.

Common Swift Dependencies

The swift_deps extension from rules_swift_package_manager will attempt to add all dependencies specified in each module's swift_deps_index.json. If multiple modules share some set of Swift libraries as their depdency, it will attempt to create the same repository target causing Bazel to error.

To work around this, there is a rules_swift_package_manager.patch file in this repository, generated from v0.22.0, that adds a simple deduplication of libraries. This allows each one to only be specified once. The downside of this patch is that the deduplication does not take into account of the versions, and so either version of the depdnency may be used.

Steps to apply the workaround:

1. Copy the rules_swift_package_manager.patch to your local repository (patches require to be local to the repo)
2. Add this in MODULE.bazel, under bazel_dep(name = "rules_swift_package_manager",...):

single_version_override(
    module_name = "rules_swift_package_manager",
    patches = ["//:rules_swift_package_manager.patch"],
    patch_strip = 1, # Remove 1 directory level, as it's a git diff
)