SpringBoot整合Swagger2

io.springfox

springfox-swagger2

2.6.1

io.springfox

springfox-swagger-ui

2.6.1

二、Swagger配置类

其实这个配置类，只要了解具体能配置哪些东西就好了，毕竟这个东西配置一次之后就不用再动了。 特别要注意的是里面配置了api文件也就是controller包的路径，不然生成的文档扫描不到接口。

package cn.saytime;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.PathSelectors;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

/**

• @author zh

• @ClassName cn.saytime.Swgger2

• @Description

• @date 2017-07-10 22:12:31

*/

@Configuration

public class Swagger2 {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

.apis(RequestHandlerSelectors.basePackage(“cn.saytime.web”))

.paths(PathSelectors.any())

.build();

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title(“springboot利用swagger构建api文档”)

.description(“简单优雅的restfun风格，http://blog.csdn.net/saytime”)

.termsOfServiceUrl(“http://blog.csdn.net/saytime”)

.version(“1.0”)

.build();

}

}

Application.class 加上注解@EnableSwagger2 表示开启Swagger

Ps：用@Configuration注解该类，等价于XML中配置beans；用@Bean标注方法等价于XML中配置bean。

package cn.saytime;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@SpringBootApplication

@EnableSwagger2

public class SpringbootSwagger2Application {

public static void main(String[] args) {

SpringApplication.run(SpringbootSwagger2Application.class, args);

}

}

三、Restful 接口

package cn.saytime.web;

import cn.saytime.bean.JsonResult;

import cn.saytime.bean.User;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiImplicitParams;

import io.swagger.annotations.ApiOperation;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

import springfox.documentation.annotations.ApiIgnore;

import java.util.ArrayList;

import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

/**

• @author zh

• @ClassName cn.saytime.web.UserController

• @Description

*/

@RestController

public class UserController {

// 创建线程安全的Map

static Map<Integer, User> users = Collections.synchronizedMap(new HashMap<Integer, User>());

/**

• 根据ID查询用户

• @param id

• @return

*/

@ApiOperation(value=“获取用户详细信息”, notes=“根据url的id来获取用户详细信息”)

@ApiImplicitParam(name = “id”, value = “用户ID”, required = true, dataType = “Integer”, paramType = “path”)

@RequestMapping(value = “user/{id}”, method = RequestMethod.GET)

public ResponseEntity getUserById (@PathVariable(value = “id”) Integer id){

JsonResult r = new JsonResult();

try {

User user = users.get(id);

r.setResult(user);

r.setStatus(“ok”);

} catch (Exception e) {

r.setResult(e.getClass().getName() + “:” + e.getMessage());

r.setStatus(“error”);

e.printStackTrace();

}

return ResponseEntity.ok®;

}

/**

• 查询用户列表

• @return

*/

@ApiOperation(value=“获取用户列表”, notes=“获取用户列表”)

@RequestMapping(value = “users”, method = RequestMethod.GET)

public ResponseEntity getUserList (){

JsonResult r = new JsonResult();

try {

List userList = new ArrayList(users.values());

r.setResult(userList);

r.setStatus(“ok”);

} catch (Exception e) {

r.setResult(e.getClass().getName() + “:” + e.getMessage());

r.setStatus(“error”);

e.printStackTrace();

}

return ResponseEntity.ok®;

}

/**

• 添加用户

• @param user

• @return

*/

@ApiOperation(value=“创建用户”, notes=“根据User对象创建用户”)

@ApiImplicitParam(name = “user”, value = “用户详细实体user”, required = true, dataType = “User”)

@RequestMapping(value = “user”, method = RequestMethod.POST)

public ResponseEntity add (@RequestBody User user){

JsonResult r = new JsonResult();

try {

users.put(user.getId(), user);

r.setResult(user.getId());

r.setStatus(“ok”);

} catch (Exception e) {

r.setResult(e.getClass().getName() + “:” + e.getMessage());

r.setStatus(“error”);

e.printStackTrace();

}

return ResponseEntity.ok®;

}

/**

• 根据id删除用户

• @param id

• @return

*/
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

总结

这个月马上就又要过去了，还在找工作的小伙伴要做好准备了，小编整理了大厂java程序员面试涉及到的绝大部分面试题及答案，希望能帮助到大家

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
*

总结

这个月马上就又要过去了，还在找工作的小伙伴要做好准备了，小编整理了大厂java程序员面试涉及到的绝大部分面试题及答案，希望能帮助到大家

[外链图片转存中…(img-8w3gT3G7-1711825158895)]

[外链图片转存中…(img-8uXclk6K-1711825158895)]

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！