YMFE
【功能需求】
版本号
~
什么问题
~希望能够支持保存请求与相应的JSON示例，这样才能很好的知道数据的JSON格式与意思。仅需要在 接口->接口列表->编辑 中的 请求参数设置 与 返回数据中 添加一个TabPane 展示第一次导入JSON的数据即可。 然后导出markdown时将请求示例与返回示例的JSON直接打印出来即可。
如何复现此问题
~
什么浏览器
~
什么系统（Linux, Windows, macOS）
魔盒项目
魔盒接口
基本信息
Path： /post/man_1565315446403
Method： POST
接口描述： 我是接口描述呀
请求
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 | ||
| Userid | 是 | |||
| Accept | 是 | |||
| Date | 是 | |||
| Accept-Language | 是 |
请求参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| isOpenName | String | 是 | openName | ||
| obj | Object | 是 | |||
| attr | String | 是 | tempo |
请求样例
{
"isOpenName": "openName",
"obj": {
"attr": "tempo"
}
}
返回数据
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | Number | 是 | 0 | ||
| result | Object | 是 | |||
| msg | String | 是 | success |
返回样例
{
"code": 0,
"result": "",
"msg": "success"
}
上面是markdown的建议样例。 下面是反馈建议。
我只是觉得当前的格式不够简洁明了，提了点建议，如有不妥，请见谅。
1.编辑页面中保留导入的json格式的请求样例与返回样例。 2.导出的markdown，表格就直接使用markdown的表格格式。 这样在Typora中修改非常方便，同时从Typora等markdown编辑工具导出的pdf客观性更高，同时导出.docx不会出现大量乱码。 3.限定markdown中的表格列宽，后面展现的整体性观感更好。
- 按照你的描述，你的需求类似于postman提供的examples，于注释较为充足的yapi来说，我觉的意义没那么大。如果这个需求很必要的话，这个功能可能自行二次开发更为合适。
- 另外我注意到你的API里都没有填写备注，是有什么原因吗？
- 按我个人使用这么久来看,充分的备注基本上能够使API的使用者了解不同的字段的含义已经如何赋值
- 如果你是idea&java&spring用户且未使用其他的API导出插件，可以考虑试试easy-yapi，当然你也可以尝试其他的插件，选择最适合当前需求的。
我需要从YAPI中导出接口文档，不是从我的IDEA中导出接口到YAPI。 我这边多半使用的都是json数据，请求的数据和返回的数据都是json. 需要一个样例来知道json的请求体格式与返回格式。 由于外部业务需求需要导出文档，所以才使用markdown作为导出格式，然后弄成pdf。
导出的可以添加选项是否导出样例的呀，就像勾选是否导出接口的wiki。 导出那可以弄个插件的，但是我是后台开发者，只会一点Vue。 React的开发对我来说还是一定难度，并且我发觉我的WebStrom不能很好启动该项目。
