tangcent / easy-yapi

Generate API document to yapi
https://easyyapi.com
GNU Affero General Public License v3.0
439 stars 144 forks source link

[Question] 支持yapi接口界面的备注功能么? #1164

Closed suoyiman closed 1 month ago

suoyiman commented 2 months ago

现在export yapi会把界面上原来编写的备注清空 20240912-120115

tangcent commented 2 months ago

你的意思是希望有个选项,导出到yapi的时候可以不覆盖在yapi接口界面手动编辑的备注?

suoyiman commented 2 months ago

是的,现在更新后就把界面上写的备注清空了。另外,有可以在代码中编写这里的备注,然后通过easy-yapi导出的功能么?在文档里没有查到。

tangcent commented 2 months ago

是的,现在更新后就把界面上写的备注清空了。

我看看加个配置来选择不覆盖备注。

另外,有可以在代码中编写这里的备注,然后通过easy-yapi导出的功能么?在文档里没有查到。

直接在API方法上写注释就行了 https://easyyapi.com/documents/java_doc_demo.html

suoyiman commented 2 months ago

期待。场景就是复杂接口会在备注里写哪个版本更新了哪些字段,方便前端对接。这部分没写进方法注释。

tangcent commented 2 months ago

场景就是复杂接口会在备注里写哪个版本更新了哪些字段,方便前端对接。这部分没写进方法注释。

这个信息你会写在代码注释里吗? 还是只是在yapi界面上去编辑?

suoyiman commented 1 month ago

场景就是复杂接口会在备注里写哪个版本更新了哪些字段,方便前端对接。这部分没写进方法注释。

这个信息你会写在代码注释里吗? 还是只是在yapi界面上去编辑?

不会在代码里写,代码有历史可以看,不用写。只在yapi界面上简单写下

tangcent commented 1 month ago

OK,了解