开源的 API 工具上了阮一峰老师的 weekly 推荐,也没有获得几个 star

252 天前
 rookie2luochao
  1. 它是一个简单轻量、比 swagger-ui 更美观的 openapi 接口文档,可以快速的生成模拟请求参数并调用 api 请求,UI 设计简洁美观、聚焦实用功能、使用简单方便、对很多信息的填写支持很好(诸如时间、文件、选择多个枚举等等)。
  2. 它还提供类似 postman 的手动填写请求信息页面,对比较难填的字段做了填写优化(例如:时间字段、文件字段)。
  3. 它有着符合程序猿审美的简洁 UI 布局, 可以快捷模拟上百个字段的请求参数,手动填写 body 数据会提示字段名称和字段类型
  4. 可以全局动态配置 Authorization 和接口请求超时时间,省略每个接口去填 Authorization 请求头,可以不同接口都切换不同的等待时间
  5. 代码完全开源,还可以基于此项目二次开发(服务器托管公司所有微服务 api 文档,快捷切换选择指定 api 文档进行查阅测试)
  6. 基于 react18 + ts5 + vite5 + Docker 技术栈,为前端开发提供一个开发到部署的标准模板

UI 展示

7421 次点击
所在节点    程序员
71 条回复
yangheng4922
252 天前
感觉还是挺丑,
rookie2luochao
252 天前
@yangheng4922 需要你的改造,来个 pr
huangliu
252 天前
我年前两期上了阮一峰老师的 weekly ,外加通过他 weekly 让其他自媒体看到并自发宣传,那段时间涨了 1k 多星。他的流量和影响力还是很高的
luojianxhlxt
252 天前
单纯说说我的想法,我这边用 swagger 之后,apifox/postman 之类的导入后,就没 swagger 啥事了。。。没啥动力切换掉 swagger
bv
252 天前
当时还试用了一下,看到 UI 直接没有继续使用的欲望了,OP 在做这个选题的时候可能都没有简单的市场调研和竟品分析。
1. UI 确实不咋好看。
2. 部署需要轻便,简单的 html 引入 js css 就可以部署运行,弄个 docker 有点重了。
3. 参考下列竟品,做好交互。
https://petstore.swagger.io/
https://elements-demo.stoplight.io/
https://scalar.com/
https://redocly.github.io/redoc/
Rache1
252 天前
swagger 的之前看到过这个,感觉还不错

GitHub - xiaoymin/knife4j: Knife4j is a set of Swagger2 and OpenAPI3 All-in-one enhancement solution
https://github.com/xiaoymin/knife4j
foolishcrab
252 天前
1. 这个品类上已经有巨头占据生态位,没有用的欲望
2.看的人觉得技术上没有特别的地方,不想 star

磨练下自己技术挺好的,不建议投入太多精力
amon
252 天前
接口文档工具太多了,不建议再重复造轮子了。
rookie2luochao
252 天前
@foolishcrab 主要是自己用一下,玩一玩,谢谢,不会投入过多精力
rookie2luochao
252 天前
@amon 好的,最开始只是公司内部需要一个文档管理平台,后面自己砍掉了很多可视化功能并开源了文档部分
rookie2luochao
252 天前
@Rache1 这个是 java 的一个集成工具,听说也不是很好用,国产挺难的,可能都是玩一下为主吧
LHRUN
252 天前
可能有的看一下使用意愿不强就不想点进 github 了,阮一峰老师的 weekly 还是很顶的,之前我上过,涨了几百 star

建议重新改一下设计,感觉你应该不经常做 C 端应用
coolcoffee
252 天前
Op 可以参考竞品 redoc 。引入一个 js https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js ,ajax 加载 openapi 的 json 或 yaml 生成文档。


https://github.com/Redocly/redoc
rookie2luochao
252 天前
@bv 谢谢建议哈,最开始想的是做很多功能,想用 docker 方便部署。后面成熟稳定后,就取投票好的内容弄成 html+hash 接入。UI 确实也只考虑比 swagger 好看,审美也不是很到位,毕竟自己设计。
rookie2luochao
252 天前
@LHRUN 确实很少做 C 端,中台做的多
rookie2luochao
252 天前
@coolcoffee 这个本来后面做工具层就是要做成这样的,路由也要做成 hash ,关键是有没有后来
rookie2luochao
252 天前
@luojianxhlxt 我也用了 apifox ,感觉改了接口文档需要重新加载挺麻烦的,因为最开始想着后面也是对标 swagger 这种开 html 页面
coolcoffee
252 天前
@rookie2luochao 我觉得路由不是啥问题,可以选择兼容两种,hash 或者 query 。

主要还是颜值是第一生产力,好看的 UI 感觉电脑都变轻快了😂
james2013
252 天前
你这个没有亮点,我都不想用:
1.界面布局,内容显示比有个基于 swagger 的差不少
2.功能一般
3.使用复杂,为什么你这个还要专门的前端,基于 swagger 的随着后端程序一起发布了
vivipure
252 天前
UI 不太好看,感觉太老了。可以参考 shadcn/ui 的风格,好看才吸引人

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1023482

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX