doc: add docs for swagger middleware #382
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
FGYFFFF
reviewed
Oct 18, 2022
content/en/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
FGYFFFF
reviewed
Oct 18, 2022
content/en/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
FGYFFFF
reviewed
Oct 18, 2022
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
FGYFFFF
reviewed
Oct 18, 2022
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
li-jin-gou
reviewed
Oct 22, 2022
li-jin-gou
changed the title
L2ncE
reviewed
Oct 24, 2022
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
justlorain
reviewed
Oct 24, 2022
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
BaiZe1998
reviewed
Oct 24, 2022
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
li-jin-gou
reviewed
Oct 25, 2022
content/zh/docs/hertz/tutorials/basic-feature/middleware/swagger.md
Outdated
Show resolved
Hide resolved
li-jin-gou
approved these changes
Oct 25, 2022
|
LGTM |
|
|
||
| ## 使用用法 | ||
|
|
||
| 1. 在你的 API 源代码中添加注释, [参考 Declarative Comments Format](https://github.com/swaggo/swag/blob/master/README.md#declarative-comments-format)。 |
| go install github.com/swaggo/swag/cmd/swag@latest | ||
| ``` | ||
|
|
||
| 3. 在你的 Go 项目的根目录下运行 [Swag](https://github.com/swaggo/swag) (例如 `~/root/go-peoject-name`)，[Swag](https://github.com/swaggo/swag) 将解析注释并生成必要的文件(`docs` 文件夹和 `docs/doc.go`)在 `~/root/go-peoject-name/docs` 目录下。 |
There was a problem hiding this comment.
这个文档里面出现了多次 Swag 链接，可以用如下方式：
[Swag][Swag]
...
[Swag][Swag]
...
// 文末
[Swag]: https://github.com/swaggo/swag
3 tasks
3 tasks
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?
docs
What this PR does / why we need it (en: English/zh: Chinese):
en: Improve docs for swagger middleware
zh: 完善 swagger 中间件文档
Which issue(s) this PR fixes: