golang/ent
1
0
Fork 0
mirror of https://github.com/ent/ent.git synced 2026-04-30 14:40:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc/md: a detailed tutorial on the gRPC integration (#1663)

Browse Source
This commit is contained in:
Rotem Tamir
2021-06-28 16:36:08 +03:00
committed by GitHub
parent d3a0b89864
commit dbd420bff5
10 changed files with 939 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/md/tutorial-grpc-intro.md Normal file
View File

@@ -0,0 +1,25 @@
---
id: grpc-intro
title: gRPC Introduction
sidebar_label: Introduction
---
[gRPC](https://grpc.io) is a popular RPC framework open-sourced by Google, and based on an internal system developed
there named "Stubby". It is based on [Protocol Buffers](https://developers.google.com/protocol-buffers), Google's
language-neutral, platform-neutral extensible mechanism for serializing structured data.
Ent supports the automatic generation of gRPC services from schemas using a plugin available in [ent/contrib](https://github.com/ent/contrib).
On a high-level, the integration between Ent and gRPC works like this:
* A command-line (or code-gen hook) named `entproto` is used to generate protocol buffer definitions and gRPC service
definitions from an ent schema. The schema is annotated using `entproto` annotations to assist the mapping between
the domains.
* A protoc (protobuf compiler) plugin, `protoc-gen-entgrpc`, is used to generate an implementation of the gRPC service
definition generated by `entproto` that uses the project's `ent.Client` to read and write from the database.
* A gRPC server that embeds the generated service implementation is written by the developer.
In this tutorial we will build a fully working gRPC server using the Ent/gRPC integration.
### Code
The final code for this tutorial can be found in [rotemtam/ent-grpc-example](https://github.com/rotemtam/ent-grpc-example).