202 Star 1.9K Fork 613

张奇峰 / GinSkeleton

 / 详情

建议支持API文档功能

待办的
创建于  
2021-01-16 21:31

当前项目暂未发现API文档支持,可否支持下文档功能,以便于方便调试。
目前已知的思路有两种:swagger 或者 graphql

评论 (7)

anson 创建了任务
anson 关联仓库设置为张奇峰/GinSkeleton
展开全部操作日志

Api文档这块,我们自己也用过go-swagger,但是界面太丑了,今后找找有界面美观、支持在线调试的考虑在20201年更新进去!
你用过的,综合体验比较好的api文档系统也可以推荐一下.

Api文档这块,我们自己也用过go-swagger,但是界面太丑了,今后找找有界面美观、支持在线调试的考虑在20201年更新进去!
你用过的,综合体验比较好的api文档系统也可以推荐一下.

@张奇峰 go-swagger 界面丑, 也可以先出一个啊, 不然app端, 前端开发的时候 后端 还得手撸文档额

我也支持增加API文档功能,对接起来方便太多

我也支持增加API文档功能,对接起来方便太多

@funkingka

主线版本V1.5.00已经发布了,基于v1.5版本的 Admin系统前后端接下来会推出,
api文档在admin系统发布之后才能开发。

张哥,swagger虽然丑,但是可以将swagger.json导入yapi中,就很好看了

可以生成SWAG的JSON,然后整合,刀哥的 http://knife4j.xiaominfo.com/doc.html#/home

api接口文档,swagger是代码入侵方式的,导致项目代码最终看起来很乱,不打算对接swagger。

下半年我会想办法以无代码入侵的方式,结合市面上已有开源api接口系统,提供一个比较完美的解决方案。

目前我们公司api接口文档用的是 showdoc 开源文档系统,缺点就是接口文档无法在线直接调试。

登录 后才可以发表评论

状态
负责人
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
参与者(6)
1630834 daitougege 1578956384 5006094 funkingka 1578978352
Go
1
https://gitee.com/daitougege/GinSkeleton.git
git@gitee.com:daitougege/GinSkeleton.git
daitougege
GinSkeleton
GinSkeleton

搜索帮助