api-testing icon indicating copy to clipboard operation
api-testing copied to clipboard

Support the execution records

Open LinuxSuRen opened this issue 1 year ago • 22 comments

这是开源之夏 2024 中的题目,如果您对该题目感兴趣并符合开源之夏对学生的要求,先不要着急动手,请遵守开源之夏官方的时间线以及其他规定。谢谢!

支持用户在 Web 界面上操作时,保留每次接口测试的请求以及响应信息。该功能包括前后端部分,后端部分需要至少包含一种后端存储(例如:MySQL、KV等)。其他方面的要求:

  • 后端单测覆盖率 80+%
  • 后端集成测试
  • 用户可以从前端看到执行历史记录(默认限制数量为 50 条)
  • 考虑如何兼容不同协议(restFul、gRPC)的 Request 和 Response
  • 支持把执行记录转为 curl 命令
  • 相关的必要文档

建议

  • 完成一些 Good first issue 有助于您更好地从代码层面了解这个项目。这个不会作为选择潜在学生的硬性要求。
  • 调研同类产品,了解不同产品的优缺点
  • 在官方规定的 Proposal 提交截止时间之前通过邮件(linuxsuren at gmail)预约腾讯会议(或类似工具)进行沟通

为什么要选择这个题目

  • 您对 Web 开发感兴趣,尤其是不反感同时进行前、后端开发(个人观点:开发者不应该把自己局限到某个语言上,而是发现、解决问题本身上,而开发语言只是一个偏好而已)
  • 您对开发工具感兴趣,之后可能会做和接口开发有关系的工作(也就是可能会持续使用该工具)
  • 作者本人对开源非常有热情,之前有作为 GSoC、开源之夏GLCC mentor 的经验
  • 作者本人对代码、文档的质量要求相对比较高
  • 活动期间会组织在线会议(协商周期)进行交流沟通,并把会议录屏上传哔哩哔哩

其他

下面是方便大家开发、测试用的一个 Demo 项目。项目采用 SpringBoot 开发,提供了一些用于测试的 APIs:

LinuxSuRen avatar Mar 11 '24 06:03 LinuxSuRen

1)MySQL:跟了黑马的100个视频,到索引调优之前,不过忘得差不多了;跟了必知必会的代码;看了点实战45讲 2)KV:没有做过Tiny KV,grpc等项目 刚做了webserver,大二,可以参加吗,想法是,大二暑期,实习或者项目二选一

11days avatar Mar 27 '24 08:03 11days

@11days 感谢您对这个项目的关注。个人觉得实习和开源之夏活动并不冲突的,确保和导师及时沟通、按时完成项目就可以的。具体如何参与请仔细阅读官网的说明。

https://summer-ospp.ac.cn/help/student/

LinuxSuRen avatar Mar 27 '24 08:03 LinuxSuRen

您好,我想问下这个项目在windows下可以编译吗?以及怎么编译呀?使用go build?

hahahashen avatar Apr 09 '24 12:04 hahahashen

Go 是支持在主流平台上运行、编译的,同时也支持跨平台编译(例如:在 Windows 上编译出 Linux 的可执行文件)。对于后端部分,最简单的就是把 Go 安装好后,在根目录执行:go build

LinuxSuRen avatar Apr 09 '24 13:04 LinuxSuRen

如果安装了Make for Windows,可以尝试使用make build进行编译。

Ink-33 avatar Apr 09 '24 13:04 Ink-33

谢谢大家的回答!我想问下这个社区有官方的交流群吗

hahahashen avatar Apr 10 '24 06:04 hahahashen

谢谢大家的回答!我想问下这个社区有官方的交流群吗

建议通过 issue 或 discussion 交流,方便信息的归档、搜索,也能避免 IM 中低质量的交流。当然,不排除跟进后续的发展有变化。

LinuxSuRen avatar Apr 10 '24 07:04 LinuxSuRen

hi All, In order to make all the potential students (or contributors) know more about this project. I just booked an online meeting for it. Please feel free to put this on you calendar and join us. And I highly recommend you prepare some questions. I will record the meeting, then upload it to Bilibili. See you there.

https://meeting.tencent.com/dm/z6sRTjC66Mh4

Record: https://www.bilibili.com/video/BV1Fp421Q7Ve/

LinuxSuRen avatar Apr 23 '24 05:04 LinuxSuRen

导师你好,我是研二学生,有开发简单网页(React, Express, MongoDB)的经验,比较熟悉Postman。
对这个项目很感兴趣,目前在自学Go和Vue,希望有机会能出一份力。🫡

kinue00 avatar May 01 '24 00:05 kinue00

@kinue00 欢迎,项目报名还有段时间,可以借这段时间抓紧练习下 Go 和 Vue,尤其是参与下 good first issue 来熟悉项目。

LinuxSuRen avatar May 05 '24 10:05 LinuxSuRen

导师你好,我是大二学生,了解go gin gorm grpc ,希望可以为这个开源项目做出贡献

wt-goodluck avatar May 14 '24 09:05 wt-goodluck

hi @wt-goodluck ,首先感谢您关注这个项目,也欢迎积极参与进来。可以按照这个 issue 里给出的建议熟悉下同类产品、源码、good-first-issue。

看到您也发邮件给我了,就在这里一并回复了。如果有其他具体问题欢迎随时通过邮件、issue 沟通

LinuxSuRen avatar May 14 '24 09:05 LinuxSuRen

hi All, I will host the second meeting for those interested in this project.

Date: 2024/5/25 20:00 Link: https://meeting.tencent.com/dm/WiI7vwyzPSkf Record: https://www.bilibili.com/video/BV1Vr421L7Q1/

I'll answer any potential questions related to this project.

LinuxSuRen avatar May 17 '24 01:05 LinuxSuRen

导师您好,我是大三学生,系统学习过前端开发,自学过后端开发,熟悉的预言是js和java,熟悉的框架有Vue、Express、SSM,有使用uniapp做过跨平台软件,同时也会使用postman、apifox等工具,不好意思关注开源之夏的时间有点晚,现在和您联系还来得及吗

hellorealworld1 avatar May 29 '24 16:05 hellorealworld1

hi @hellorealworld1 ,感谢您对项目的关注,官方给出的报名截止日期为 6月4日。感兴趣的话,可以抓紧翻阅下当前 issue 中给出的相关信息,包括:建议、两次的会议记录等等。有一些同学已经通过 good-first-issue 对项目代码结构有了一定了解,这也是非常好的一个起点,加油。

看到您也给我发过邮件,就在此一并回复了。如果还有其他任何疑问、问题,都可以在相关渠道进行交流。

LinuxSuRen avatar May 30 '24 01:05 LinuxSuRen

导师你好,我是大一学生,能够用go独立搭建一个后端项目,关注的比较晚,现在正在了解项目,希望来得及

bugoutianzhen123 avatar May 31 '24 07:05 bugoutianzhen123

@bugoutianzhen123 同学您好,感谢您对项目的关注,只要是在官方截止报名之前能完成报名都有机会的。但考虑到时间确实比较紧张了。如果想要报名的话,这几天最好能多花点时间了解这个 issue 中相关的信息。

LinuxSuRen avatar May 31 '24 07:05 LinuxSuRen

本次开源之夏议题收到 6 份申请,我们会尽量详细地根据给出的信息(设计+项目参与情况等)来给出排序。再次感谢各位同学对项目的关注。

LinuxSuRen avatar Jun 05 '24 13:06 LinuxSuRen

截止目前为止,收到 9 位同学的邮件咨询,11 位同学提交的 PR 有合并,其中有位同学提交了 6 个 PR。有两次在线会议沟通,录屏播放量累计 233 次。

另外,大部分同学有通过 issue、邮件沟通、交流。

希望每一位同学都能匹配到自己感兴趣的项目,如果万一有没匹配成功的,也非常欢迎持续关注、参与到我们这个项目当中来。走出校门之前,有丰富、长期参与开源项目的经历,相信能够给你就业之路添加一抹亮。

本次排序方法,基本参考这里的说明

LinuxSuRen avatar Jun 10 '24 09:06 LinuxSuRen

项目正式开始,第一次会议:

  • 会议时间:2024/07/02 20:15-22:15
  • 会议链接:https://meeting.tencent.com/dm/JBZTq1iBNJ7r
  • 录屏:https://www.bilibili.com/video/BV12z421z7ux/

LinuxSuRen avatar Jul 01 '24 00:07 LinuxSuRen

Milestone:

  • [ ] 初步实现前端页面。 (2 week 7.8-7.22)
  • [ ] 完成各项功能的定义与实现。 (2.5 week 7.22-8.9 )
  • [ ] 完善测试、开发模块中存在问题。 (1 week 8.9-8.16 )

SamYSF avatar Jul 16 '24 04:07 SamYSF

@SamYSF 建议以上每个阶段至少提交一个 PR,最后一个大概率可能会有多个。另外,如果要先实现前端的话,需要考虑下有个开关来隐藏(显示)新功能,等到功能完全可用再去掉开关。

LinuxSuRen avatar Jul 16 '24 05:07 LinuxSuRen

image

这里需要调整下,对于 ORM 以外的插件是不支持执行历史的,需要把相应的按钮隐藏了。

LinuxSuRen avatar Sep 19 '24 12:09 LinuxSuRen

image image image image image

这几处也可以考虑优化下

LinuxSuRen avatar Sep 23 '24 09:09 LinuxSuRen

恭喜🎉 @SamYSF 顺利完成开源之夏的活动。

LinuxSuRen avatar Sep 30 '24 01:09 LinuxSuRen

恭喜🎉 @SamYSF 顺利完成开源之夏的活动。

感谢 Rick 哥活动期间的指导。我收获很大,期待以后能参与更多开源活动。

SamYSF avatar Sep 30 '24 08:09 SamYSF