Beego搭建api服务，自动生成文档。

古城微笑少年丶 2022-06-18 05:36 352阅读 0赞

在网上找了一些例子，为了应用方便，自己简单记录一下。前提条件：配置GOPATH、GOBIN、PATH

一、检查环境配置，很重要！

Ubuntu16.04下配置（~/.bashrc）如下：

export GOPATH=/home/user/go
    export GOBIN=$GOPATH/bin
    export PATH=$PATH:${GOPATH//://bin:}/bin

查看go环境配置情况：

user@user-OptiPlex-9010:~/go/src/pp$ go env
    GOARCH="amd64"
    GOBIN="/home/user/go/bin"
    GOEXE=""
    GOHOSTARCH="amd64"
    GOHOSTOS="linux"
    GOOS="linux"
    GOPATH="/home/user/go"
    GORACE=""
    GOROOT="/usr/lib/go-1.6"
    GOTOOLDIR="/usr/lib/go-1.6/pkg/tool/linux_amd64"
    GO15VENDOREXPERIMENT="1"
    CC="gcc"
    GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0"
    CXX="g++"
    CGO_ENABLED="1"

使环境变量生效：

source ~/.bashrc

二、下载bee工具

go get github.com/beego/bee

三、应用

新建简单ａｐｉ项目

bee api myPro

cd myPro

bee run -downdoc=true -gendoc=true

![Center][]

默认监听端口为８０８０

检测是否成功：http://localhost:8080/swagger/

![Center 1][]

![Center 2][]

[Center]: /images/20220618/6dcc8911787c40f5972e7ee2e5728b72.png
[Center 1]: /images/20220618/4c477ee7499d49fca1cc722b91c9a8ee.png
[Center 2]: /images/20220618/2c89cc03a38043e790ac80e0c5fe6b62.png

发表评论取消回复

表情：

评论列表（有 0 条评论，352人围观）

还没有评论，来说两句吧...

相关阅读

相关 API文档生成困惑：Java如何自动生成清晰易懂的API文档？

在Java中自动生成清晰易懂的API文档，你可以使用一些流行的库和工具来帮助你。以下是一些常用的方法和工具： 1. **Javadoc**： - Javadoc是Java自带

深碍√TFBOYSˉ_/ 2024年11月11日 20:06/ 0 赞/ 124 阅读

相关最佳实践：Swagger 自动生成 Api 文档

目录 Tapir 介绍为什么使用 Tapir 快速使用 Tapir 添加依赖定义一个端点(Endpoint) 生成 Swagger ui 根据 yaml 生成

忘是亡心i/ 2024年03月23日 21:36/ 0 赞/ 176 阅读

相关 beego生成 api 项目 && api 文档

目标生成 api 项目，并且自动生成db的mapper、module等；同时生成api文档操作步骤 1、生成 api 项目，并且自动生成db全表的映射 bee ap

ゝ一纸荒年。/ 2023年06月02日 05:29/ 0 赞/ 15 阅读

相关 mock2easy环境搭建和gitbook文档自动生成

第一步先在服务器上准备node环境 yum -y install gcc make gcc-c++ openssl-devel wget 下载源码及解压：

╰半橙微兮°/ 2022年09月30日 03:40/ 0 赞/ 216 阅读

相关 Beego搭建api服务，自动生成文档。

在网上找了一些例子，为了应用方便，自己简单记录一下。前提条件：配置GOPATH、GOBIN、PATH 一、检查环境配置，很重要！ Ubuntu16.04下配置（~/.

古城微笑少年丶/ 2022年06月18日 05:36/ 0 赞/ 353 阅读

相关 tp5 自动生成api文档

\api-doc 使用方法 \\\\1、安装扩展 composer require weiwei/api-doc dev-master > 由于我没发布版本

布满荆棘的人生/ 2022年05月25日 01:36/ 0 赞/ 406 阅读

相关 swagger自动生成API文档

swagger自动生成API文档一、pom.xml配置  <dependency> <groupId

た入场券/ 2022年05月16日 11:44/ 0 赞/ 544 阅读

相关 mock2easy环境搭建和gitbook文档自动生成

第一步先在服务器上准备node环境 yum -y install gcc make gcc-c++ openssl-devel wget 下载源码及解压：

女爷i/ 2022年04月08日 09:20/ 0 赞/ 265 阅读

相关 CodeIgniter+swagger实现 PHP API接口文档自动生成功能自动生成ci RESTFUL api接口文档

一、安装swagger 1、首先需要有composer，没有的自行百度安装 2、下载swagger，打开网站[https://packagist.org/package

﹏ヽ暗。殇╰゛Y/ 2022年04月02日 04:37/ 0 赞/ 585 阅读

相关 shoDoc自动生成API文档使用说明

shoDoc使用说明操作系统windos,其他操作系统见官网介绍自动生成API 主要步骤： 1. 安装git for windows :[git][

冷不防/ 2021年07月26日 23:40/ 0 赞/ 767 阅读