https://github.com/nu11ptr/connect2axum
Generate REST/OpenAPI endpoint wrappers over ConnectRPC endpoints
https://github.com/nu11ptr/connect2axum
Last synced: 20 days ago
JSON representation
Generate REST/OpenAPI endpoint wrappers over ConnectRPC endpoints
- Host: GitHub
- URL: https://github.com/nu11ptr/connect2axum
- Owner: nu11ptr
- License: mit
- Created: 2026-05-06T00:11:18.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-06T01:56:20.000Z (about 2 months ago)
- Last Synced: 2026-05-06T02:22:56.187Z (about 2 months ago)
- Language: Rust
- Size: 17.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# connect2axum [](https://crates.io/crates/connect2axum) [](https://docs.rs/connect2axum) [](https://github.com/nu11ptr/connect2axum/actions) [](https://github.com/nu11ptr/connect2axum/blob/main/LICENSE)
Generate REST and/or WebSocket endpoint wrappers over ConnectRPC services.
Additionally, generate OpenAPI docs for REST endpoints and AsyncAPI docs for
WebSocket endpoints.
## Install
```sh
cargo install --locked connect2axum-codegen
```
This installs:
- `protoc-gen-connect2rest`
- `protoc-gen-connect2ws`
- `protoc-gen-connect2openapi`
- `protoc-gen-connect2asyncapi`
## Plugin Options
Options are passed as comma-separated `name=value` pairs in `buf.gen.yaml`.
```yaml
plugins:
- local: protoc-gen-connect2rest
out: src/generated/connect2axum
opt:
- buffa_module=crate::proto
- connect_module=crate::connect
- local: protoc-gen-connect2ws
out: src/generated/connect2axum
opt:
- buffa_module=crate::proto
- connect_module=crate::connect
- local: protoc-gen-connect2openapi
out: src/generated/openapi
strategy: all
opt:
- config=connect2openapi.yaml
- local: protoc-gen-connect2asyncapi
out: src/generated/asyncapi
strategy: all
opt:
- config=connect2asyncapi.yaml
```
### Active Options
| Option | Default | Used By | Purpose |
| --- | --- | --- | --- |
| `buffa_module` | `crate::proto` | REST, WS | Rust module root where Buffa generated messages are available. |
| `connect_module` | `crate::connect` | REST, WS | Rust module root where Connect Rust generated service traits are available. |
| `runtime_module` | `::connect2axum` | REST, WS | Rust path to the runtime helper crate/module. |
| `streaming_content_type` | `application/x-ndjson` | REST | REST streaming response content type. |
| `suppress_pkg_prefix` | `true` | OpenAPI, AsyncAPI | Omit protobuf package prefixes from document component names and references. |
| `value_suffix` | `__` | REST, WS | Suffix for generated local bindings to avoid collisions with request fields. |
| `type_suffix` | `__` | REST | Suffix for generated DTO type names. |
| `body_message_suffix` | `Body` | REST | Suffix for generated body DTOs. |
| `query_message_suffix` | `Query` | REST | Suffix for generated query DTOs. |
### OpenAPI Generator
`protoc-gen-connect2openapi` wraps grpc-gateway's
`protoc-gen-openapiv3`, then patches the generated document for connect2axum
REST behavior. It supports `output`, `config`, `openapiv3_bin`,
`openapiv3_opt`, `streaming_content_type`, and `suppress_pkg_prefix` plugin
options.
See [docs/openapi-generator.md](docs/openapi-generator.md) for config format
and backend details.
### AsyncAPI Generator
`protoc-gen-connect2asyncapi` emits AsyncAPI v3.1 JSON for the JSON WebSocket
routes generated by `protoc-gen-connect2ws`. It supports `output`, `config`,
`server_url`, `default_content_type`, and `suppress_pkg_prefix` plugin options.
See [docs/asyncapi-generator.md](docs/asyncapi-generator.md) for document shape
and config details.
### WebSocket Notes
`protoc-gen-connect2ws` only generates JSON WebSocket routes for streaming RPCs.
Unary RPCs stay REST/Connect-only. Client and bidirectional request streams end
with an empty text frame so the socket can remain open for any response frames.