当前位置：
凯发ag旗舰厅登录网址下载 >
前端技术
> javascript
>内容正文
javascript
springboot整合swagger指南 -凯发ag旗舰厅登录网址下载
凯发ag旗舰厅登录网址下载
收集整理的这篇文章主要介绍了
springboot整合swagger指南
小编觉得挺不错的,现在分享给大家,帮大家做个参考.
springboot整合swagger指南
1. 安装使用
1.1 下载依赖
<dependency><groupid>io.springfoxgroupid><artifactid>springfox-swagger2artifactid><version>2.9.2version> dependency> <dependency><groupid>io.springfoxgroupid><artifactid>springfox-swagger-uiartifactid><version>2.9.2version> dependency>不同版本，配置有所差异，最好采用相同版本
1.2 编写swagger配置文件
@configuration @enableswagger2 public class swaggerconfig {@beanpublic docket docket() {return new docket(documentationtype.swagger_2).apiinfo(myapiinfo());}private apiinfo myapiinfo() {contact default_contact = new contact("夏2同学", "http://appletest.cn", "1754082565@qq.com");return new apiinfo("api documentation","api documentation description...","1.0","urn:tos",default_contact,"apache 2.0","http://www.apache.org/licenses/license-2.0",new arraylist());}}1.3 启动使用
对，springboot集成swagger，就是这么简单！
启动后，就可以看到我们的swagger界面。
它默认会扫描，我们项目下面的所有controller和bean层，帮助我们直接生成文档。
controller部分代码如下：
@restcontroller @api(description = "hello工程") public class hellocontroller {@getmapping("/hello")@apioperation("hello的api")public string hello(@apiparam("用户名") string username){return "hello " username;}@postmapping("/post")public string post(string username, @requestparam string password){return "hello " username ", " password;}}2. 注解使用
通过使用注解，可以让swagger上显示的信息更加语义化，减少沟通的成本。
2.1 用于注解pojo的两个：
@apimodel(description = content类描述) public class content { @apimodelproperty(标题) private string title;实例：
@data @allargsconstructor @noargsconstructor @apimodel("user实体类") public class user {@apimodelproperty("用户名")private string username;@apimodelproperty("密码")private string password;@apimodelproperty("生日")private date birthdate; }swagger运行效果：
2.2 用于控制器类的3个
@api(tags = {index控制器}) // tags是对controller的接口重新分类 @controller public class indexcontroller {@apioperation(getcontent方法)@getmapping("/test")@responsebodypublic content getcontent(@apiparam(名字) @requestparam string name) { 与50位技术专家面对面20年技术见证，附赠技术全景图总结
以上是凯发ag旗舰厅登录网址下载为你收集整理的springboot整合swagger指南的全部内容，希望文章能够帮你解决所遇到的问题。
如果觉得凯发ag旗舰厅登录网址下载网站内容还不错，欢迎将凯发ag旗舰厅登录网址下载推荐给好友。
- 上一篇：
- 下一篇： springboot下使用mybatis