docs: improve route doc #361
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
li-jin-gou
force-pushed
the
docs/router_improve
branch
2 times, most recently
from
ed7ec4d
to
bcc689c
Compare
zstone12
reviewed
Sep 21, 2022
| | `Hertz.PATCH` | 用于注册 HTTP Method 为 PATCH 的方法 | | ||
| | `Hertz.HEAD` | 用于注册 HTTP Method 为 HEAD 的方法 | | ||
| | `Hertz.OPTIONS` | 用于注册 HTTP Method 为 OPTIONS 的方法 | | ||
| | `Hertz.Handle` | 这个方法支持用户手动传入 HTTP Method 用来注册方法，当用于注册普通的 HTTP Method 方法时和上述的方法作用是一致，但是这个方法同时支持用于注册自定义 HTTP Method 方法 | |
There was a problem hiding this comment.
「是一致」->「是一致的」，这个方法同时也支持用于注册自定义 HTTP Method 方法。(感觉这样更通顺些？:D
li-jin-gou
force-pushed
the
docs/router_improve
branch
from
bcc689c
to
9e1b1b2
Compare
zstone12
reviewed
Sep 21, 2022
|
|
||
| ### 使用匿名函数与装饰器注册路由 | ||
|
|
||
| 在使用匿名函数或装饰器注册路由时，如果我们需要使用 `RequestContext.HandlerName()` 获取 handler 名称会获取到错误的名称。 |
There was a problem hiding this comment.
如果我们需要使用 RequestContext.HandlerName() 获取 handler 名称会获取到错误的名称。 ->「如果我们使用RequestContext.HandlerName() 获取 handler 名称则会获取到错误的名称。」
|
Welcome CR and not merged for now |
li-jin-gou
force-pushed
the
docs/router_improve
branch
from
9e1b1b2
to
fadf3f6
Compare
Skyenought
reviewed
Sep 21, 2022
|
|
||
| 如果我们设置`/src/*filepath`路由，匹配情况如下 | ||
| 如果我们设置`/src/*path`路由，匹配情况如下 | ||
|
|
||
| | path | | |
There was a problem hiding this comment.
| path | | -> | 路径 | 是否匹配 |
li-jin-gou
force-pushed
the
docs/router_improve
branch
2 times, most recently
from
507b813
to
0779207
Compare
KevinChens
reviewed
Sep 23, 2022
|
|
||
| ### 获取路由注册信息 | ||
|
|
||
| Hertz 提供了 `Routes` 获取注册的路由信息(http method、http path、handler name)供用户使用. |
There was a problem hiding this comment.
应该使用中文标点符号，typo：使用. -> 使用。
li-jin-gou
force-pushed
the
docs/router_improve
branch
from
0779207
to
825754d
Compare
li-jin-gou
force-pushed
the
docs/router_improve
branch
3 times, most recently
from
f6832bb
to
cba641c
Compare
Comment on lines
64
to
66
| // will registers a route that matches all the HTTP methods. | ||
| h.Any("/ping_any", func(ctx context.Context, c *app.RequestContext) { | ||
| c.String(consts.StatusOK,"any") | ||
| }) |
There was a problem hiding this comment.
- 为啥只在这个注册方法加了注释，其它方法要不要也加呢？
- consts.StatusOK,"any" 少了空格
|
|
||
| ### 获取路由注册信息 | ||
|
|
||
| Hertz 提供了 `Routes` 获取注册的路由信息(http method、http path、handler name)供用户使用。 |
li-jin-gou
force-pushed
the
docs/router_improve
branch
7 times, most recently
from
6c3c59f
to
0a54cdc
Compare
li-jin-gou
force-pushed
the
docs/router_improve
branch
from
0a54cdc
to
b0c510c
Compare
GuangmingLuo
approved these changes
Sep 29, 2022
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
doc
What this PR does / why we need it (en: English/zh: Chinese):
en: improve route doc
zh: 改善路由文档中文部分
Which issue(s) this PR fixes: