From d4240cd4b04674d0ace571e3e695a31fc3b1108a Mon Sep 17 00:00:00 2001 From: janetyu <931242644@qq.com> Date: Wed, 30 Sep 2020 14:22:37 +0800 Subject: [PATCH] perfect the bookstore and shorturl doc (#109) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * perfect the bookstore and shorturl doc * 避免歧义 --- doc/bookstore-en.md | 4 +++- doc/bookstore.md | 4 +++- doc/shorturl-en.md | 4 +++- doc/shorturl.md | 4 +++- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/bookstore-en.md b/doc/bookstore-en.md index 81b0625f..260ac52f 100644 --- a/doc/bookstore-en.md +++ b/doc/bookstore-en.md @@ -69,7 +69,7 @@ And now, let’s walk through the complete flow of quickly create a microservice GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl ``` -* create the working dir bookstore +* create the working dir `bookstore` and `bookstore/api` * in `bookstore` dir, execute `go mod init bookstore` to initialize `go.mod`` @@ -191,6 +191,8 @@ And now, let’s walk through the complete flow of quickly create a microservice ## 6. Write code for add rpc service +- under directory `bookstore` create dir `rpc` + * under directory `rpc/add` create `add.proto` file ```shell diff --git a/doc/bookstore.md b/doc/bookstore.md index f3ebde45..061ccd8b 100644 --- a/doc/bookstore.md +++ b/doc/bookstore.md @@ -69,7 +69,7 @@ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl ``` -* 创建工作目录`bookstore` +* 创建工作目录 `bookstore` 和 `bookstore/api` * 在`bookstore`目录下执行`go mod init bookstore`初始化`go.mod` @@ -191,6 +191,8 @@ ## 6. 编写add rpc服务 +- 在 `bookstore` 下创建 `rpc` 目录 + * 在`rpc/add`目录下编写`add.proto`文件 可以通过命令生成proto文件模板 diff --git a/doc/shorturl-en.md b/doc/shorturl-en.md index a2f1a25d..fd43e916 100644 --- a/doc/shorturl-en.md +++ b/doc/shorturl-en.md @@ -72,7 +72,7 @@ And now, let’s walk through the complete flow of quickly create a microservice GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl ``` -* create the working dir `shorturl` +* create the working dir `shorturl` and `shorturl/api` * in `shorturl` dir, execute `go mod init shorturl` to initialize `go.mod` @@ -195,6 +195,8 @@ And now, let’s walk through the complete flow of quickly create a microservice ## 6. Write code for transform rpc service +- under directory `shorturl` create dir `rpc` + * under directory `rpc/transform` create `transform.proto` file ```shell diff --git a/doc/shorturl.md b/doc/shorturl.md index f62241e3..b61504ed 100644 --- a/doc/shorturl.md +++ b/doc/shorturl.md @@ -72,7 +72,7 @@ GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl ``` -* 创建工作目录`shorturl` +* 创建工作目录 `shorturl` 和 `shorturl/api` * 在`shorturl`目录下执行`go mod init shorturl`初始化`go.mod` @@ -195,6 +195,8 @@ ## 6. 编写transform rpc服务 +- 在 `shorturl` 目录下创建 `rpc` 目录 + * 在`rpc/transform`目录下编写`transform.proto`文件 可以通过命令生成proto文件模板