当前位置:  开发笔记 > 前端 > 正文

从Swagger文档生成Yaml或Json文件

如何解决《从Swagger文档生成Yaml或Json文件》经验,为你挑选了1个好方法。

我使用swagger-springmvc注释开发了一些由swagger记录的Rest Web服务.现在,我想使用swagger-editor生成客户端Rest Web服务代码,但swagger-editor需要Yaml或Json文件.你知道是否有办法生成这个文件?提前谢谢

编辑: 这可以通过使用swagger-mvn-plugin完成,但我没有找到如何做到的例子?



1> MK-rou..:

我回复自己:).您可以使用swagger-maven-plugin生成客户端和服务器端文档(yaml,json和html)

将其添加到您的pom.xml:

.....
 
                com.github.kongchen
                swagger-maven-plugin
                3.0.1
                
                    
                        
                            true
                            com.yourcontrollers.package.v1
                            http,https
                            localhost:8080
                            /api-doc
                            
                                Your API name
                                v1
                                 description of your API
                                
                                    http://www.yourterms.com
                                
                                
                                    your-email@email.com
                                    Your Name
                                    http://www.contact-url.com
                                
                                
                                    http://www.licence-url.com
                                    Commercial
                                
                            
                            
                            ${basedir}/templates/strapdown.html.hbs
                            ${basedir}/generated/document.html
                            generated/swagger-ui
                            
                                
                                    basicAuth
                                    basic
                                
                            
                        
                    
                
             ........

您可以在以下地址下载*.hbs模板:https: //github.com/kongchen/swagger-maven-example

mvn swagger:generate 将在项目/generated/swagger/目录中生成执行Json文档.过了这个地址:http: //editor.swagger.io

并生成您想要的任何内容(您首选技术中的服务器端或客户端API)

推荐阅读
N个小灰流_701
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有