使用Beego创建API项目并自动化文档

最近需要使用Go写一个Web API项目,可以使用Beego与Gin来写此类项目,还是非常方便的,这里就介绍一下使用Beego来创建的Web API项目并自动化文档的方法。

使用Gin创建API项目并自动化文档参见:使用Gin编写Web API项目并自动化文档

一、准备环境

go install github.com/beego/bee/v2@latest

二、创建API项目

bee api api

在这里插入图片描述

1. 下载项目依赖

$ cd api
$ go mod tidy

在这里插入图片描述

此时项目目录结构如下:

$ tree
.
├── conf
│   └── app.conf
├── controllers
│   ├── object.go
│   └── user.go
├── go.mod
├── go.sum
├── main.go
├── models
│   ├── object.go
│   └── user.go
├── routers
│   └── router.go
└── tests└── default_test.go6 directories, 10 files

2. 生成路由

bee generate routers

在这里插入图片描述

该命令会生成routers/commentsRouter.go文件。

$ tree
.
├── conf
│   └── app.conf
├── controllers
│   ├── object.go
│   └── user.go
├── go.mod
├── go.sum
├── main.go
├── models
│   ├── object.go
│   └── user.go
├── routers
│   ├── commentsRouter.go
│   └── router.go
└── tests└── default_test.go6 directories, 11 files

此时可以在浏览器中浏览:http://127.0.0.1:8080/v1/user/

在这里插入图片描述
注意,这里不能使用https

三、自动化文档与测试

每次手动测试API还是比较繁琐的,为了方便测试,可以使用swagger来进行API辅助测试。

bee run -gendoc=true -downdoc=true

在这里插入图片描述

此时默认使用的是https://petstore.swagger.io/v2/swagger.json配置文件

在这里插入图片描述

可以手动将前面的路径去掉,只保留swagger.json,然后测试,会发现有问题:

	
Failed to fetch.
Possible Reasons:CORS
Network Failure
URL scheme must be "http" or "https" for CORS request.

在这里插入图片描述

需要修改swagger/index.html

在这里插入图片描述

url: "https://petstore.swagger.io/v2/swagger.json"替换成url: "/swagger/swagger.json"。再测试就正常了:

在这里插入图片描述

如何写注释,让swagger自动生成接口文档,可以参考:https://beego.wiki/zh-cn/docs/advantage/docs/

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/834783.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

粮油码垛机:自动化与智能化仓储的关键角色

在快速发展的现代化仓储物流领域,粮油码垛机正逐渐成为自动化与智能化仓储的关键角色。它以其高效、精准、节省人力的特点,赢得了众多粮油生产企业的青睐,成为仓储管理升级换代的明星产品。 一、粮油码垛机的技术革新 随着科技的发展&#…

AI写的论文AI疑似度太高怎么办?教你一招解决

随着 AI 技术迅猛发展,各种AI辅助论文写作的工具层出不穷! 为了防止有人利用AI工具进行论文代写,在最新的学位法中已经明确规定“已经获得学位者,在获得该学位过程中如有人工智能代写等学术不端行为,经学位评定委员会…

每日Attention学习4——Spatial Attention Module

模块出处 [link] [code] [MM 21] Complementary Trilateral Decoder for Fast and Accurate Salient Object Detection 模块名称 Spatial Attention Module (SAM) 模块作用 空间注意力 模块结构 模块代码 import torch import torch.nn as nn import torch.nn.functional a…

搞了半天的HTTP-ONLY

一、问题 事情是这样的,我在测试服务器cookie时,要将键名为 onlintTag 的 value值 获取出来,一只没办法。 js一只报undefined,如下图 但是 请求头和响应体 都 显示了 cookie中 onlintTag的 value ,如下图 二、HTTP-ON…

菲菲的作业

一、输出打印姓名、学号(以Python为例) Python 1name "张三" 2student_id "20200001" 3print("姓名:", name) 4print("学号:", student_id) 二、提取身份证号码中的出生年份和月份&…

代码复现|DataLoader类num_workers参数引发的进程问题

一、问题描述 记录一下:复现(Windows平台下,机器学习算法)代码过程中遇到的多进程问题,报错截图如下。 根据排查定位到代码出错位置349行。(背景介绍:logprog封装了dataloader类,本质…

基于 stable diffusion 制作上世纪90年代的游戏美术风格

1. 项目背景 目前游戏项目中出现美术产能不足的瓶颈,如果使用 midjourney 之类的第三方生成式人工智能产品生成美术素材的话,一方面需要将我们的美术资产投喂给第三方企业进行风格训练,有安全性上的风险,另一方面,第三…

F1C200S 添加韦根驱动笔记(设备树修改)

参考资料:linux开发笔记(buildroot 增加自己的开发板支持文件)-CSDN博客 首先需要有F1C200S开发板的原理图和buildroot 如果没有可以在我的资源里面下载。 参考上面的文章修改这个目录下的设备树即可。 /home/test/lc/buildroot/board/wi…

Android 开机启动模式源码分析

在机器关机情况下,长按Power键启动机器,如果这时机器低电,会提示低电,机器不会正常启动: 而代码如下: 如果不是低电,正常情况是可以启动的。 在关机情况下,插入USB,机…

【Python深度学习(第二版)(3)】初识神经网络之深度学习hello world

文章目录 一. 训练Keras中的MNIST数据集二. 工作流程1. 构建神经网络2. 准备图像数据3. 训练模型4. 利用模型进行预测5. (新数据上)评估模型精度 本节将首先给出一个神经网络示例,引出如下概念。了解完本节后,可以对神经网络在代码上的实现有一个整体的了…

python数据分析——pandas DataFrame基础知识2

参考资料:活用pandas库 1、分组方式 我们可以把分组计算看作“分割-应用-组合”(split-apply-combine)的过程。首先把数据分割成若干部分,然后把选择的函数(或计算)应用于各部分,最后把所有独立…

如何安全高效地进行分公司文件下发?

确保分公司文件下发过程中的保密性和安全性,是企业信息安全管理的重要组成部分。以下是一些关键步骤和最佳实践: 权限管理:确保只有授权的人员可以访问文件。使用权限管理系统来控制谁可以查看、编辑或下载文件。 加密传输:在文…

Linux|进程地址空间

Linux|内存地址空间 现象基本概念理解如何理解地址空间什么是划分区域&#xff1f;地址空间的理解为什么要有地址空间&#xff1f;如何进一步理解页表和写时拷贝如何理解虚拟地址 Linux真正的进程调度方案 现象 #include <stdio.h> #include <string.h> #include …

Go 使用 MongoDB

MongoDB 安装(Docker)安装 MongoDB Go 驱动使用 Go Driver 连接到 MongoDB在 Go 里面使用 BSON 对象CRUD 操作 插入文档更新文档查询文档删除文档 下一步 MongoDB 安装(Docker) 先装个 mongo&#xff0c;为了省事就用 docker 了。 docker 的 daemon.json 加一个国内的源地址…

Milvus基本概念及其应用场景

Milvus是一款云原生向量数据库&#xff0c;具备高可用、高性能、易拓展的特点&#xff0c;主要用于海量向量数据的实时召回。以下是关于Milvus的基本概念解释&#xff1a; 向量数据库&#xff1a;Milvus是一个向量数据库&#xff0c;用于存储、索引和管理通过深度神经网络和机…

用Java爬虫解决问题:探索网络数据的奥秘

网络爬虫是一种用于自动获取互联网信息的程序&#xff0c;常用于搜索引擎、数据挖掘等领域。本文将介绍如何使用Java编写网络爬虫来解决问题&#xff0c;并提供具体的代码实现及测试&#xff0c;帮助读者掌握爬虫技术并应用于实际项目中。 1. 爬虫原理 爬虫通过模拟人类浏览器…

C++容器——set

set容器 是一个关联容器&#xff0c;按一定的顺序存储一组唯一的元素。 set容器中的元素会根据元素的值自动进行排序&#xff0c;并且不允许包含重复的元素&#xff0c;基于二叉树实现的。 特点&#xff1a; 唯一性&#xff1a; set容器中的元素是唯一的&#xff0c;即容器中…

Java 区块链应用 | 割韭菜之假如K线涨跌可随意变动修改的实现

大家好&#xff0c;我是程序员大猩猩。 我一直在想&#xff0c;币圈这个行情时涨时跌&#xff0c;不断的割韭菜&#xff0c;不是由市场决定的&#xff01;而是由交易所直接输入一个数值后点击确定按钮而变化的&#xff0c;那么是不是很恐怖的行为。 为了验证这么一个想法&…

【代码随想录算法训练Day2】LeetCode 977.有序数组的平方、LeetCode 209.长度最小的子数组、LeetCode 59.螺旋矩阵II

Day2 数组、双指针 LeetCode 977.有序数组的平方【排序/双指针】 要将数组的每个元素平方后在按非递减的顺序&#xff0c;最简单的方法就是先将每个数平方&#xff0c;再将结果数组排序。 解法1&#xff1a;排序 class Solution { public:vector<int> sortedSquares(…

Java实现Excel导入和校验

文章目录 效果实现1,添加依赖2,实体类Member.javaMemberVO.java3,校验、监听器ValidationTool.javaExcelReadListener.java4,请求接口参考博文效果 输入:导入测试.xlsx postman调用实例: postman输出结果: 日志输出: 实现 1,添加依赖 easyexcel要去掉poi-ooxm…