Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webrpc/gen-golang
webrpc Golang client/server generator
https://github.com/webrpc/gen-golang
client generator go golang server webrpc
Last synced: 3 days ago
JSON representation
webrpc Golang client/server generator
- Host: GitHub
- URL: https://github.com/webrpc/gen-golang
- Owner: webrpc
- License: mit
- Created: 2022-10-05T15:26:45.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T14:44:47.000Z (about 2 months ago)
- Last Synced: 2024-11-18T16:04:22.926Z (about 2 months ago)
- Topics: client, generator, go, golang, server, webrpc
- Language: Go
- Homepage: https://github.com/webrpc/webrpc
- Size: 266 KB
- Stars: 13
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
webrpc-gen Golang templates
===============================
This repo contains the templates used by the `webrpc-gen` cli to code-generate
webrpc Go server and client code.
## Usage
```
webrpc-gen -schema=example.ridl -target=golang -out=./example.gen.go -pkg=main -server -client
# or
webrpc-gen -schema=example.ridl -target=github.com/webrpc/[email protected] -out=./example.gen.go -pkg=main -server -client
# or
webrpc-gen -schema=example.ridl -target=./local-go-templates-on-disk -out=./example.gen.go -pkg=main -server -client
```
As you can see, the `-target` supports default `golang`, any git URI, or a local folder :)
### Set custom template variables
Change any of the following values by passing `-option="Value"` CLI flag to `webrpc-gen`.
| webrpc-gen -option | Default | Description | Added in |
|--------------------|------------|-----------------------------------------------------------------------------|----------|
| `-pkg=` | `"proto"` | package name | v0.5.0 |
| `-client` | `false` | generate client code | v0.5.0 |
| `-server` | `false` | generate server code | v0.5.0 |
| `-types=false` | `true` | don't generate types | v0.13.0 |
| `-json=jsoniter` | `"stdlib"` | use alternative json encoding package | v0.12.0 |
| `-fixEmptyArrays` | `false` | force empty array `[]` instead of `null` in JSON (see Go [#27589][go27589]) | v0.13.0 |
| `-errorStackTrace` | `false` | enables error stack traces | v0.14.0 |
| `-webrpcHeader` | `true` | enable client send webrpc version in http headers | v0.16.0 |
Example:
```
webrpc-gen -schema=./proto.json -target=golang -out server.gen.go -pkg=main -server
```
## Set custom Go field meta tags in your RIDL file
| CLI option flag | Description |
|----------------------------------------------|------------------------------------------------------------------|
| `+ go.field.name = ID` | Set custom field name |
| `+ go.field.type = uuid.UUID` | Set custom field type (must be able to JSON unmarshal the value) |
| `+ go.type.import = github.com/google/uuid` | Set custom field type's import path |
| `+ go.tag.json = id` | Set `json:"id"` struct tag |
| `+ go.tag.db = id` | Set `db:"id"` struct tag |
Example:
```ridl
struct User
- ID: int64
+ go.tag.db = id
+ go.tag.json = id
- UUID: string
+ go.field.type = uuid.UUID
+ go.type.import = github.com/google/uuid
+ go.tag.json = uuid
+ go.tag.db = uuid
- Age: int
+ go.tag.db: age
- Name: string
+ go.tag.db = name
- PasswordHash: string
+ go.tag.db = passwd_hash
```
will result in
```go
import "github.com/google/uuid"
type User struct {
ID int64 `json:"id" db:"id"`
UUID uuid.UUID `json:"uuid" db:"uuid"`
Name string `db:"name"`
Age int `db:"age"`
PasswordHash string `json:"-" db:"passwd_hash"`
}
```
## Examples
See [_examples](./_examples)
## LICENSE
[MIT LICENSE](./LICENSE)
[go27589]: https://github.com/golang/go/issues/27589