Swagger-Codegen的简单使用
来源:互联网 发布:网络大电影名词解释 编辑:程序博客网 时间:2024/03/29 22:28
前言
说句实在话,丝袜哥(Swagger)为我们提供了非常多的工具,其中最强的还要算这个代码的生成工具了。啊哈哈,下面,就和阿福一起来看看怎么用吧!
实际上我们都知道,在当今这个前后端分离的大环境下,前后端之间订立的接口契约就显得尤为重要,中国不是有一句古话讲的好吗,君子一言,驷马难追,而契约也大抵如此,也就是说契约在订立之后变动的可能性已经很小,这就要求我们提前的去设计契约,也就是我们为前端提供的API。但是我们可以发现,我们在开发过程中订立的契约的寿命其实不怎样长,这是一件非常严重的事情,因此丝袜哥为我们提供了另外一种比较优雅的方式,那就是你先订立契约,然后在去用生成的契约也就是接口文档去生成代码,这是非常好的一种实践方式。下面,我们就来看看应该如何做吧!
准备环境
当然,你要使用对方的代码生成工具,一定首先定义好你的接口文件,这里的接口大致上我们前面所提到的json文件。而我们当然还需要其相应的jar包,因为阿福是学java的。看起来似乎颇为复杂,哎许,下载下来jar之后还要学习怎莫用?实际上,阿福也觉得实在是太复杂了,难道就没有简单一点的配置吗?答案是,有。
生成项目
那就是去在线的Swagger-Editor上面就可以自动生成啦,啊哈哈!不过如果你没有翻墙的话,那访问速度真的是非常的感人啊!进去之后,你将会看到如下图的一个页面:
好了,上面的图片中我们可以点击generate server,当然,在生成之前,丝袜哥要我们选择一下我们所使用的语言和框架,丝袜哥的这个版本使用Spring生成的项目将是Spring-Boot结构,因为目前Spring-Boot已经非常流行了啦!
然后,我们下载下来它之后导入我们的Idea即可看到一个完整的Spring-Boot的项目结构。然后就可以直接启动了。当然,Spring-Boot的项目如何启动在此就不做赘述了。前面的文章已经有讲过了。是不是非常的方便。当然,启动之后我们就可以看到如下的美丽画面。
总结
今天的话我们简单的学习了Swagger-codegen的简单生成代码。之所以说简单,是因为我们压根不需要做任何的配置的啦!但是我想要传达的非常重要的一点是,永远在学习新的技术的时候首先找官网的文档和资料,这是非常重要的。
好了,今天的分享到这里就结束了。祝大家工作愉快!当然,如果大家还没有进到Swagger-Editor的在线版本的话,我已经把丝袜哥为大家生成的项目上传到了我的github上。项目的地址如下:
Swagger-Codegen示例项目
- Swagger-Codegen的简单使用
- SpringMVC集成Swagger插件以及Swagger注解的简单使用
- API生命周期第三阶段:API实施:使用swagger codegen生成可部署工程,择取一个作为mock service
- swagger 的使用
- Swagger UI的使用
- swagger的使用
- swagger注解的使用
- 例程codegen功能之一:限制软件的使用期限
- 使用slick的codegen生成table code等
- swagger-codegen生成java客户端代码(其他语言类似)
- swagger -- ref 自定义的使用
- vs出现CODEGEN的错误
- swagger使用
- Swagger使用
- swagger使用
- 有关core data有关Codegen使用过程中出现的问题
- 使用swagger生成API的json文件
- django-rest-swagger的优化使用
- Java分布式应用如何入门以及有哪些资料?
- 【实训记录】山东大学场馆管理系统实训笔记之——数据库设计
- Linux中基于hadoop安装hive(CentOS7+hadoop2.8.0+hive2.1.1)
- 双目标定log文件
- idea2017创建maven web项目
- Swagger-Codegen的简单使用
- VMwareTools安装
- Python--time模块
- vue-cli脚手架的使用时eslint报错
- Hadoop基础教程-第3章 HDFS:分布式文件系统(3.1 HDFS概述)
- 微信小程序之用户数据解密
- 17年黑龙江ACM省赛总结
- JavaScript核心基础语法
- pvanet训练网络时的一些小技巧