{"id":15062782,"url":"https://github.com/nhatthm/grpcui-redoc","last_synced_at":"2026-01-21T14:02:41.909Z","repository":{"id":38303556,"uuid":"456535056","full_name":"nhatthm/grpcui-redoc","owner":"nhatthm","description":"Redoc Theme for gRPC UI","archived":false,"fork":false,"pushed_at":"2024-04-18T10:02:00.000Z","size":137,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-01T21:04:24.320Z","etag":null,"topics":["api-docs","docs","go","golang","grpc","grpcui","postman","redoc","theme"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nhatthm.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-07T14:15:44.000Z","updated_at":"2024-05-29T00:28:41.960Z","dependencies_parsed_at":"2023-02-14T15:31:04.764Z","dependency_job_id":"ee0f9fc9-86b2-4717-904a-41192f6f8084","html_url":"https://github.com/nhatthm/grpcui-redoc","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/nhatthm/grpcui-redoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhatthm%2Fgrpcui-redoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhatthm%2Fgrpcui-redoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhatthm%2Fgrpcui-redoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhatthm%2Fgrpcui-redoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nhatthm","download_url":"https://codeload.github.com/nhatthm/grpcui-redoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nhatthm%2Fgrpcui-redoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28634786,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-docs","docs","go","golang","grpc","grpcui","postman","redoc","theme"],"created_at":"2024-09-24T23:46:27.018Z","updated_at":"2026-01-21T14:02:41.888Z","avatar_url":"https://github.com/nhatthm.png","language":"CSS","funding_links":["https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY"],"categories":[],"sub_categories":[],"readme":"# Redoc Theme for gRPC UI\n\n[![GitHub Releases](https://img.shields.io/github/v/release/nhatthm/grpcui-redoc)](https://github.com/nhatthm/grpcui-redoc/releases/latest)\n[![Build Status](https://github.com/nhatthm/grpcui-redoc/actions/workflows/test.yaml/badge.svg)](https://github.com/nhatthm/grpcui-redoc/actions/workflows/test.yaml)\n[![codecov](https://codecov.io/gh/nhatthm/grpcui-redoc/branch/master/graph/badge.svg?token=eTdAgDE2vR)](https://codecov.io/gh/nhatthm/grpcui-redoc)\n[![Go Report Card](https://goreportcard.com/badge/github.com/nhatthm/grpcui-redoc)](https://goreportcard.com/report/github.com/nhatthm/grpcui-redoc)\n[![GoDevDoc](https://img.shields.io/badge/dev-doc-00ADD8?logo=go)](https://pkg.go.dev/github.com/nhatthm/grpcui-redoc)\n[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)\n\nRedoc Theme for [gRPC UI](https://github.com/fullstorydev/grpcui/)\n\n[Don't gRPC without it!](https://www.fullstory.com/blog/grpcui-dont-grpc-without-it/)\n\n## Prerequisites\n\n- `Go \u003e= 1.22`\n\n## Install\n\n```bash\ngo get github.com/nhatthm/grpcui-redoc\n```\n\n## Usage\n\nUse `grpcuiredoc.HandlerViaReflection()` or `grpcuiredoc.Handler()` the same way as `fullstorydev/grpcui`.\n\nFor example:\n\n```go\npackage exmaple\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"os\"\n\t\"path/filepath\"\n\n\tgrpcuiredoc \"github.com/nhatthm/grpcui-redoc\"\n\t\"google.golang.org/grpc\"\n\t\"google.golang.org/grpc/reflection\"\n)\n\nfunc main() {\n\t// ----------------------------\n\t// Start up our gRPC server\n\t// ----------------------------\n\tsvr := grpc.NewServer()\n\n\t// we need the reflection service, to power the UI\n\treflection.Register(svr)\n\n\t// ...\n\t// register our gRPC services and then start up the server in a goroutine\n\t// ...\n\n\t// ----------------------------\n\t// Create a client to local server\n\t// ----------------------------\n\tcc, err := grpc.Dial(fmt.Sprintf(\"127.0.0.1:%d\", grpcPort))\n\tif err != nil {\n\t\tpanic(fmt.Errorf(\"failed to create client to local server: %w\", err))\n\t}\n\n\t// ----------------------------\n\t// Create gRPCui handler\n\t// ----------------------------\n\ttarget := fmt.Sprintf(\"%s:%d\", filepath.Base(os.Args[0]), grpcPort)\n\t// This one line of code is all that is needed to create the UI handler!\n\th, err := grpcuiredoc.HandlerViaReflection(ctx, cc, target)\n\tif err != nil {\n\t\tpanic(fmt.Errorf(\"failed to create client to local server: %w\", err))\n\t}\n\n\t// ----------------------------\n\t// Now wire it up to an HTTP server\n\t// ----------------------------\n\tserveMux := http.NewServeMux()\n\n\tserveMux.Handle(\"/grpcui/\", http.StripPrefix(\"/grpcui\", h))\n}\n```\n\n![image](https://user-images.githubusercontent.com/1154587/153202990-13515fc3-9a9e-433c-909e-101d167381ae.png)\n\n## Donation\n\nIf this project help you reduce time to develop, you can give me a cup of coffee :)\n\n### Paypal donation\n\n[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)\n\n\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;or scan this\n\n\u003cimg src=\"https://user-images.githubusercontent.com/1154587/113494222-ad8cb200-94e6-11eb-9ef3-eb883ada222a.png\" width=\"147px\" /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhatthm%2Fgrpcui-redoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnhatthm%2Fgrpcui-redoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnhatthm%2Fgrpcui-redoc/lists"}