search

xiaoymin / blog-comments

blog-comments
0 stars 0 forks source link

离线文档(Markdown) | swagger-bootstrap-ui #101

Open xiaoymin opened 5 years ago

xiaoymin commented 5 years ago

http://doc.xiaominfo.com/guide/offline-md.html

swagger-bootstrap-ui 指南

zuihou commented 5 years ago

能做个下载功能就好了

robben009 commented 5 years ago

大佬 能不能做个直接可以生成带有目录的html和PDF文件就好了。虽然markdown能转成html和pdf,但是第三方没有什么好用的，还不带目录。要是能直接下载或者生成就好了。这个功能我觉得挺实用的，毕竟有时候我们给第三方接口文档，第三发只认带目录的PDF

xiaoymin commented 5 years ago

@hujingzheng 大佬 能不能做个直接可以生成带有目录的html和PDF文件就好了。虽然markdown能转成html和pdf,但是第三方没有什么好用的，还不带目录。要是能直接下载或者生成就好了。这个功能我觉得挺实用的，毕竟有时候我们给第三方接口文档，第三发只认带目录的PDF

目前官方比较全的有一个组件叫swagger-codegen,可以支持导出各种格式的

但是这个jar比较大,做成服务的方式调用接口可能会好一点,但是接口还是比较隐私的

后面再看看吧,knife4j-service这个模块就是规划准备对接这部分的

robben009 commented 5 years ago

@xiaoymin

@hujingzheng 大佬 能不能做个直接可以生成带有目录的html和PDF文件就好了。虽然markdown能转成html和pdf,但是第三方没有什么好用的，还不带目录。要是能直接下载或者生成就好了。这个功能我觉得挺实用的，毕竟有时候我们给第三方接口文档，第三发只认带目录的PDF

目前官方比较全的有一个组件叫swagger-codegen,可以支持导出各种格式的

但是这个jar比较大,做成服务的方式调用接口可能会好一点,但是接口还是比较隐私的

后面再看看吧,knife4j-service这个模块就是规划准备对接这部分的

期待中

bgk3967832 commented 4 years ago

帮了大忙了，一直看着官方的好难看，牛逼

u804311 commented 4 years ago

请我打包成jar放到服务器，怎么读取md文件？

wunian7yulian commented 4 years ago

遇到 导出md文档时 请求/响应示例 使用的代码块语言为javascript 而不是json或者xml 例: 响应数据类型:*/*,application/json 响应示例: ```javascript { "imJson": true } ``` 虽然不影响阅读 但是否可以根据请求/响应数据类型数据类型而设定