beego API开发入门

下载 beego

下载 beego 前,需要做好如下准备

  • 安装好 golang 语言
  • 在系统变量中配置 GOPATH、GOBIN
  • 安装好 git
  • 下载 beego 安装包 go get github.com/astaxie/beego
  • 下载 bee 工具 go get github.com/beego/bee
  • 使用 git 进入$GOPATH/src
  • 使用命令 bee version
 ~  bee version                                                                                     ✔  1660  09:01:24
______
| ___ \
| |_/ /  ___   ___
| ___ \ / _ \ / _ \
| |_/ /|  __/|  __/
\____/  \___| \___| v1.12.0

├── Beego     : Beego is not installed. Please do consider installing it first: https://github.com/astaxie/beego
├── GoVersion : go1.15
├── GOOS      : darwin
├── GOARCH    : amd64
├── NumCPU    : 8
├── GOPATH    : /Users/xx/go
├── GOROOT    : /Users/xx/.g/go
├── Compiler  : gc
└── Date      : Tuesday, 17 Nov 2020

配置Swagger

Swagger 是一套围绕OpenAPI规范构建的开源工具,可以帮助我们设计,构建,编写和使用 REST API

  • 使用 bee generate docs 生成符合 swagger 使用的两个文档 swagger.json 和 swagger.yml
  • 使用命令 bee run -downdoc=true 更新 swagger-ui ,如果 swagger 目录没有 swagger-ui 则会自动下载安装
  • 使用命令 bee run -gendoc=true 让项目重新编译也会生成 swagger 文档
    重点:
    建议 直接使用命令 bee run -gendoc=true -downdoc=true 结合两个方法
bee run -gendoc=true -downdoc=true                                                       ✔  1660  10:07:11
______
| ___ \
| |_/ /  ___   ___
| ___ \ / _ \ / _ \
| |_/ /|  __/|  __/
\____/  \___| \___| v1.12.0
2020/11/17 10:07:17 WARN     ▶ 0001 Running application outside of GOPATH
2020/11/17 10:07:17 INFO     ▶ 0002 Using 'api_project' as 'appname'
2020/11/17 10:07:17 INFO     ▶ 0003 Initializing watcher...
2020/11/17 10:07:18 INFO     ▶ 0004 Generating the docs...
2020/11/17 10:07:18 SUCCESS  ▶ 0005 Docs generated!
2020/11/17 10:07:19 SUCCESS  ▶ 0006 Built Successfully!
2020/11/17 10:07:19 INFO     ▶ 0007 Restarting 'api_project'...
2020/11/17 10:07:19 SUCCESS  ▶ 0008 './api_project' is running...
2020/11/17 10:07:19.823 [I] [asm_amd64.s:1374]  http server Running on http://:8080
2020/11/17 10:08:02.607 [D] [server.go:2843]  |      127.0.0.1| 302 |    208.469µs|   match| GET      /swagger
2020/11/17 10:08:02.611 [D] [server.go:2843]  |      127.0.0.1| 304 |    619.492µs|   match| GET      /swagger/
2020/11/17 10:08:02.793 [D] [server.go:2843]  |      127.0.0.1| 304 |    386.191µs|   match| GET      /swagger/swagger-ui.css
2020/11/17 10:08:02.800 [D] [server.go:2843]  |      127.0.0.1| 304 |   6.856299ms|   match| GET      /swagger/swagger-ui-bundle.js
2020/11/17 10:08:02.804 [D] [server.go:2843]  |      127.0.0.1| 304 |  10.374977ms|   match| GET      /swagger/swagger-ui-standalone-preset.js
2020/11/17 10:08:03.198 [D] [server.go:2843]  |      127.0.0.1| 200 |   1.011716ms|   match| GET      /swagger/swagger.json

访问http://127.0.0.1:8080/swagger/页面
在这里插入图片描述

已标记关键词 清除标记
©️2020 CSDN 皮肤主题: 撸撸猫 设计师:设计师小姐姐 返回首页