Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhatthm/grpcui-redoc
Redoc Theme for gRPC UI
https://github.com/nhatthm/grpcui-redoc
api-docs docs go golang grpc grpcui postman redoc theme
Last synced: 3 months ago
JSON representation
Redoc Theme for gRPC UI
- Host: GitHub
- URL: https://github.com/nhatthm/grpcui-redoc
- Owner: nhatthm
- License: mit
- Created: 2022-02-07T14:15:44.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T10:02:00.000Z (9 months ago)
- Last Synced: 2024-05-01T21:04:24.320Z (8 months ago)
- Topics: api-docs, docs, go, golang, grpc, grpcui, postman, redoc, theme
- Language: CSS
- Homepage:
- Size: 134 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Redoc Theme for gRPC UI
[](https://github.com/nhatthm/grpcui-redoc/releases/latest)
[](https://github.com/nhatthm/grpcui-redoc/actions/workflows/test.yaml)
[](https://codecov.io/gh/nhatthm/grpcui-redoc)
[](https://goreportcard.com/report/github.com/nhatthm/grpcui-redoc)
[](https://pkg.go.dev/github.com/nhatthm/grpcui-redoc)
[](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
Redoc Theme for [gRPC UI](https://github.com/fullstorydev/grpcui/)
[Don't gRPC without it!](https://www.fullstory.com/blog/grpcui-dont-grpc-without-it/)
## Prerequisites
- `Go >= 1.21`
## Install
```bash
go get github.com/nhatthm/grpcui-redoc
```
## Usage
Use `grpcuiredoc.HandlerViaReflection()` or `grpcuiredoc.Handler()` the same way as `fullstorydev/grpcui`.
For example:
```go
package exmaple
import (
"fmt"
"net/http"
"os"
"path/filepath"
grpcuiredoc "github.com/nhatthm/grpcui-redoc"
"google.golang.org/grpc"
"google.golang.org/grpc/reflection"
)
func main() {
// ----------------------------
// Start up our gRPC server
// ----------------------------
svr := grpc.NewServer()
// we need the reflection service, to power the UI
reflection.Register(svr)
// ...
// register our gRPC services and then start up the server in a goroutine
// ...
// ----------------------------
// Create a client to local server
// ----------------------------
cc, err := grpc.Dial(fmt.Sprintf("127.0.0.1:%d", grpcPort))
if err != nil {
panic(fmt.Errorf("failed to create client to local server: %w", err))
}
// ----------------------------
// Create gRPCui handler
// ----------------------------
target := fmt.Sprintf("%s:%d", filepath.Base(os.Args[0]), grpcPort)
// This one line of code is all that is needed to create the UI handler!
h, err := grpcuiredoc.HandlerViaReflection(ctx, cc, target)
if err != nil {
panic(fmt.Errorf("failed to create client to local server: %w", err))
}
// ----------------------------
// Now wire it up to an HTTP server
// ----------------------------
serveMux := http.NewServeMux()
serveMux.Handle("/grpcui/", http.StripPrefix("/grpcui", h))
}
```
## Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
### Paypal donation
[](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
or scan this
