Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add: grpc web UI doc #90

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .gitbook/assets/grpc-web-ui-2.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/grpc-web-ui-method_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/grpc-web-ui-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/grpc-web-ui-response.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/grpc-web-ui-service_name.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/grpc-web-ui.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions developer-guides/grpc-web-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
description: >-
A general introduction to gRPC Web UI.
cover: ../.gitbook/assets/Discord Invite (29).png
coverY: 258
---

## Introduction

## gRPC Web UI - BETA <a href="gRPC-Web-Ui" id="grpc-web-ui"></a>

The **gRPC Web UI** is a tool for querying gRPC. Currently in **BETA**, this web-based user interface allows you to interact with gRPC servers directly from browser. Similar to Postman, but specifically designed for gRPC APIs instead of REST.


![gRPC Web UI](../.gitbook/assets/grpc-web-ui.jpeg)

## What is gRPCui?

gRPCui is a command-line tool that provides a web-based user interface for gRPC. It allows to:
- Query gRPC servers
- Interact with gRPC APIs
- Visualize responses in a user-friendly format

## Features

`grpcui` supports all RPC methods, including streaming. However, you must construct the entire stream of request messages at once, and it renders the entire response stream at once, unlike `grpcurl` which allows bidirectional interaction.

- `grpcui` supports plain-text and TLS servers, with various TLS configuration options, including mutual TLS with client certificates.

- Upon issuing an RPC, the web UI displays all gRPC response metadata, including headers and trailers, and presents the response body in a human-readable HTML table.

![gRPC Web UI](../.gitbook/assets/grpc-web-ui-2.jpeg)

## How to Use gRPCui

1. Access the tool at [https://juno.grpcui.chaintools.host/](https://juno.grpcui.chaintools.host/) or install the tool from [grpcui](https://github.com/fullstorydev/grpcui/).

To be an example, let's query tokenfactory module params. For this, choose osmosis.tokenfactory.v1beta1.Query service name.
![Service Name](../.gitbook/assets/grpc-web-ui-service_name.png)

Then, choose Params method name:

![Method Name](../.gitbook/assets/grpc-web-ui-method_name.png)

2. Use the interface to query the server and visualize the responses.

![Request](../.gitbook/assets/grpc-web-ui-request.png)

And, the response:

![Response](../.gitbook/assets/grpc-web-ui-response.png)


## Credits

[ChainTools](https://chaintools.tech).

- **@fullstorydev**: For the base code.
- **@sascha1337**: For their work in getting this tool up and running.
- **@qf3l3k_tech**: For connecting to servers.