【💰】【投票】api 文档编辑器暂时出了一版, 先部署在了腾讯云的 EO 上面, api 的调试可能调试不了, 正式版应该没有这个问题, 发出来主要是让兄弟们给提提意见 🤡

28 条回复
231 次浏览

站点地址: http://oxapi.v2ex.info/

这有一个本地的 proxy 文件, 可以使用 node 启动, 放在个人中心的配置里:

https://github.com/HelloWorldImJoe/OxApiDocument/blob/master/local-proxy.js

启动命令: node ./local-proxy.js

image


兄弟们给我提提意见, 我看看还有没有做下去的必要 🤡


附一个测试的 markdown 文件, 直接创建项目新建 md 文件就可以了:

https://github.com/HelloWorldImJoe/OxApiDocument/blob/master/Demo_API.md?plain=1


ps: 本来想用 @cnskis 大佬的文件床, 结果上传失败了 😂

文件床帖子地址: https://2libra.com/post/personal-works/J3Id-_n

投票

这个项目有没有做下去的必要

没有

选择一项进行投票,截止:2026-05-05 15:19:00

金币池
💰 476 金币

金币会随着回复数量动态增加,首次回复有概率获得金币池中部分金币奖励。

  • 附言 1

    大概的截图:

    image

    编辑模式:

    image

    现在主要是自己在用, 看看兄弟们有没有需求, 到时候大部分功能都是免费的, 只有涉及到占用我服务器资源的功能可能会收费, 这个看看再说, 估计一般也用不到, 我都会加上平替的方案.



  • 附言 2

    测试 md 文件也可以通过这个链接下载: https://file.mxpy.cn/download?code=rFg4suDCU

大平衡者
GRD

一个优化点,预览和源码看看能不能对齐

image

前排打手
OP
GRD
红队

主要是现在的 api 工具(apifox, apipost) 不让写乱七八糟的文档, 限制的太死

语雀这种文档工具里面又没法快速获取结果

再加上现在用的 api 文档工具打开太慢了

所以想要做一个这样的工具, 目前我们用着还凑合, 当然我们就 2 个人 😂

讲故事的人
GRD

看了一下,没有 MD 格式,我加一下。

复制
{
    "extensions": [
        "zip",
        "png",
        "jpg",
        "gif",
        "gz",
        "jpeg",
        "rar",
        "tar",
        "webp",
        "exe",
        "mp3",
        "mp4",
        "apk",
        "pdf",
        "7z"
    ],
    "max_size": 104857600
}
前排打手
OP
GRD
红队

说实话, 这个没咋测 😂

因为这个场景我们平时用的很少, 我看看修复一下.

感谢反馈!!

前排打手
OP
GRD
红队

收到, 还没开始扣这些细节, 主要是看看兄弟们需要这么一个东西不?

感谢反馈!

捣蛋鬼
蓝队

讲道理,本地的 api 管理会更方便一些,并且已经有了挺多竞品了

捣蛋鬼
蓝队

是用浏览器内置的存储机制么?indexedDB/localstroage 之类的?

前排打手
OP
GRD
红队

@amigo 对的, indexdb, 加了 github 的同步机制, 如果自己建了私有的 github 仓库, 可以通过 github 来同步数据做迁移或者其他操作.

卡皮巴拉
蓝队

有必要干下去!支持佬!

我好像投错了票 @Jimmy 能不能加个撤销的功能。

前排打手
OP
GRD
红队

感谢支持!!

做下去是一定的, 因为目前我和小伙伴都在用, 现在的功能满足我们平常的对接了

其实这玩意都不算什么高频的工具, 所以打算花一个人月左右的时间来做这件事, 等封板之后就不动了.

前排打手
OP
GRD
红队

有啥建议吗? 主要是看看大家要是没有需求的话 我就快速封板了, 我们自己内部使用, 哈哈哈

都听我说!
蓝队
  1. 插入 API、WebSocket、gRPC 块时,在弹框出能不能有模板复用
  2. 增加快捷键保存,现在的编辑/保存在右上角,鼠标移动路径太远
前排打手
OP
GRD
红队

@empty_null_nil 感恩, 2 确实是有问题, 打算加个自动保存了.

第一个我看看咋实现, 手动添加的话确实会方便很多

因为现在的渲染是根据```api 的特殊标识来渲染的, 里面的 md 有固定的格式, 我写了一个 mcp, 直接让 AI 把接口生成对应的 md 文件了, 然后放编辑器里面给前端用, 所以没咋考虑到手动添加的场景 🤡

马上来
红队

现在用的应该少了吧?
我是好久没用过类似调 api 的工具了

前排打手
OP
GRD
红队

主要是顺便写文档, 现在这个工具在我们内部用的频率也不高, 主要是交互 api.

我做成 md 编辑器主要是想后面知识库啥的也用这个来编辑.

发表一个评论

R保持