egg-swagger icon indicating copy to clipboard operation
egg-swagger copied to clipboard

请教这个模块怎么使用呢?

Open caiya opened this issue 6 years ago • 9 comments

请教这个模块怎么使用呢?是否支持注释路由的文档生成?

caiya avatar Dec 19 '17 11:12 caiya

跟其他 插件一样的使用方式, 需要制定 swagger.json /swagger.xml 方可查看

TheOne1006 avatar Dec 23 '17 02:12 TheOne1006

@caiya 路由注释,自己尝试过,但是生成完善的swagger 配置时,需要书写的注释 非常多,而且不易读。 所以可以参考 loopback 的思路。 推荐: https://github.com/TheOne1006/egg-connector-remote/blob/master/README.zh_CN.md,现在可以较好的支持 egg-sequelize

TheOne1006 avatar Dec 23 '17 02:12 TheOne1006

http://egg-swagger-demo.herokuapp.com/explore demo: https://github.com/TheOne1006/egg-rest-swagger-demo

TheOne1006 avatar Jan 05 '18 11:01 TheOne1006

@TheOne1006 所有的链接都404了,麻烦更新一下

zhangweiUmark avatar Feb 28 '18 03:02 zhangweiUmark

@zhangweiUmark markdown 语法没弄好,现在可以了

TheOne1006 avatar Feb 28 '18 04:02 TheOne1006

@TheOne1006 请问swagger的authorization怎么配置?

zhangweiUmark avatar Feb 28 '18 05:02 zhangweiUmark

@zhangweiUmark 案例 demo已增加 authorization 相关配置。 更多说明 : 传送门

TheOne1006 avatar Feb 28 '18 06:02 TheOne1006

@TheOne1006 我并没有使用egg-connector-remote,如果只使用了egg-swagger的话,怎么做配置呢?

zhangweiUmark avatar Mar 01 '18 02:03 zhangweiUmark

这个满足 这个格式的json 或者 yml swagger 配置文件就可以 https://egg-swagger-demo.herokuapp.com/swagger.json
具体 DEMO 可以参考 https://editor.swagger.io//?_ga=2.41951072.471192285.1510301833-940518916.1510301833#/, 等多细节 参考 swagger.io

在 egg config 配置 ‘ swaggerFilePath’ 这个属性 到 相关 的 swagger 配置文件即可

TheOne1006 avatar Mar 01 '18 03:03 TheOne1006