Skip to content

Commit

Permalink
Merge pull request beego#572 from take7yo/patch-2
Browse files Browse the repository at this point in the history
_ "beeapi/docs"引入说明补充
  • Loading branch information
astaxie authored Mar 23, 2017
2 parents 7267501 + 4bfd9d5 commit 33346b6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion zh-CN/advantage/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ func (c *CMSController) Product() {
要使得文档工作,你需要做几个事情,

- 第一开启应用内文档开关,在配置文件中设置:`EnableDocs = true`,
- 然后在你的 `main.go` 函数中引入 `_ "beeapi/docs"`
- 然后在你的 `main.go` 函数中引入 `_ "beeapi/docs"`(beego 1.7.0 之后版本不需要添加该引用)
- 这样你就已经内置了 docs 在你的 API 应用中,然后你就使用 `bee run -gendoc=true -downdoc=true`,让我们的 API 应用跑起来,`-gendoc=true` 表示每次自动化的 build 文档,`-downdoc=true` 就会自动的下载 swagger 文档查看器

好了,现在打开你的浏览器查看一下效果,是不是已经完美了。下面是我的 API 文档效果:
Expand Down

0 comments on commit 33346b6

Please sign in to comment.