1.使用maven 创建springboot工程
2.修改 pom,xml ',添加 swagger2 依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency>
3.创建 swagger2 配置类
在Application.java
同级创建Swagger2的配置类Swagger2
。
@Configuration @EnableSwagger2 public class Swagger2 { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.didispace.web")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot中使用Swagger2构建RESTful APIs") .description("更多Spring Boot相关文章请关注:http://blog.didispace.com/") .termsOfServiceUrl("http://blog.didispace.com/") .contact("程序猿DD") .version("1.0") .build(); } }
3.添加文档内容
@RestController @RequestMapping(value="/users") // 通过这里配置使下面的映射都在/users下,可去除 public class UserController { static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); @ApiOperation(value="获取用户列表", notes="") @RequestMapping(value={""}, method=RequestMethod.GET) public List<User> getUserList() { List<User> r = new ArrayList<User>(users.values()); return r; } @ApiOperation(value="创建用户", notes="根据User对象创建用户") @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User") @RequestMapping(value="", method=RequestMethod.POST) public String postUser(@RequestBody User user) { users.put(user.getId(), user); return "success"; } @ApiOperation(value="获取用户详细信息", notes="根据url的id来获取用户详细信息") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") @RequestMapping(value="/{id}", method=RequestMethod.GET) public User getUser(@PathVariable Long id) { return users.get(id); } @ApiOperation(value="更新用户详细信息", notes="根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息") @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"), @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User") }) @RequestMapping(value="/{id}", method=RequestMethod.PUT) public String putUser(@PathVariable Long id, @RequestBody User user) { User u = users.get(id); u.setName(user.getName()); u.setAge(user.getAge()); users.put(id, u); return "success"; } @ApiOperation(value="删除用户", notes="根据url的id来指定删除对象") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") @RequestMapping(value="/{id}", method=RequestMethod.DELETE) public String deleteUser(@PathVariable Long id) { users.remove(id); return "success"; } }
4.启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html
转载: http://www.jianshu.com/p/8033ef83a8ed
相关推荐
Spring Boot 中使用 Swagger2 构建 RESTful APIs Swagger 是一系列 RESTful API 的工具,通过 Swagger 可以获得项目的交互式文档,客户端 SDK 的自动生成等功能。Swagger 的目标是为 REST APIs 定义一个标准的、与...
Swagger是一个广泛使用的...以上是在Spring Boot中使用Swagger2构建RESTful APIs的相关知识点。了解和掌握这些知识点,可以帮助开发者更高效地开发、测试和维护RESTful API,同时使得API文档的管理更加规范化和自动化。
在Spring Boot项目中集成Swagger2,可以帮助我们快速地构建和维护高质量的RESTful API。以下将详细讲解如何利用Spring Boot与Swagger2进行集成,并展示其主要功能和步骤。 **一、集成Swagger2** 1. 添加依赖:首先...
.title("Spring Boot 中使用 Swagger2 构建 RESTful APIs") .contact("Zj") .version("1.0") .build(); } } ``` 配置完成后,Swagger2会自动扫描指定的包路径下的Controller,生成对应的API文档。但为了提供更...
在 Spring Boot 项目中使用 Swagger2,需要导入 Maven 依赖。当前官方最高版本是 2.8.0,但我们建议使用 2.2.2 版本,该版本稳定,界面友好。 ``` <groupId>io.springfox <artifactId>springfox-swagger2 ...
在Spring Boot应用中集成Swagger3,我们可以生成清晰的API文档,方便开发者理解和使用接口。Swagger UI允许我们在浏览器中直接测试API,极大地提高了开发效率和用户体验。Swagger3相比于之前的版本,提供了更多强大...
Spring Boot 2.7.5 是一...通过这种方式,开发者可以构建一个交互式的API文档,提高开发效率,促进前后端协作。在实际项目中,还可以进一步细化配置,比如添加分组、隐藏敏感信息、设置安全策略等,以满足不同的需求。
在Spring Boot 2.7及以上版本,它开始支持Swagger 3,这是一个强大的API文档工具,帮助开发者构建清晰、易于理解的RESTful API接口。 Swagger 3,也称为OpenAPI Specification 3.0,是Swagger的最新版本,基于...
Spring Boot 2.x基础教程:使用Swagger2构建强大的API文档 Spring Boot 2.x基础教程:JSR-303实现请求参数校验 Spring Boot 2.x基础教程:Swagger接口分类与各元素排序问题详解 Spring Boot 2.x基础教程:Swagger...
Swagger2是一个流行的API开发工具,它可以自动生成API文档,方便开发者理解和使用API。在Spring Boot项目中整合Swagger2,可以让我们轻松地管理和展示API接口,极大地提高了开发效率和协作体验。 首先,我们需要在...
在Spring Boot中使用swagger-bootstrap-ui可以提供一个更加友好的API文档和交互方式。本文将介绍在Spring Boot中使用swagger-bootstrap-ui的方法。 首先,需要在pom.xml文件中引入swagger和swagger-bootstrap-ui的...
整合到Spring Boot中,构建强大RESTful API文档。省去接口文档管理工作,修改代码,自动更新,Swagger2也提供了强大的页面测试功能来调试RESTful API。 2、Swagger2常用注解 Api:修饰整个类,描述Controller的作用...
总结,Swagger3是Spring Boot项目中用于生成API文档的强大工具,通过注解和配置,我们可以轻松地创建和管理RESTful API的文档。通过运行应用,我们可以利用Swagger UI进行接口的测试和调试,极大地提高了开发效率和...
将 Swagger 集成到 Spring Boot 中,可以实现自动化地生成 API 文档,提高开发效率。 **一、Spring Boot 集成 Swagger 前置知识** 1. **Spring Boot**:基于 Spring 框架的快速开发工具,提供自动配置、内嵌服务器...
`Spring Boot中使用Swagger2构建强大的RESTful API文档 - 简书.url`等链接提供了关于如何在Spring Boot项目中集成Swagger2的步骤,包括添加依赖、配置 Swagger 初始化、编写API注解以及如何通过Swagger UI进行交互式...
该类中需要创建一个Docket的Bean,Docket是Swagger的核心配置类,用于定义如何构建API文档。 ```java package com.yuandengta.boot.config; import org.springframework.context.annotation.Bean; import org....
Spring Boot 整合 Swagger 是一种常见的方式,用于构建RESTful API的交互式文档。Swagger 提供了一种标准化的方式来描述 RESTful API,使得开发者能够轻松地理解接口的使用方法,并进行在线调试。以下是对如何在 ...
Swagger2 是一个流行的 API 文档化工具,它允许开发者通过注解轻松地在 Spring Boot2 应用程序中创建和管理 RESTful API 的文档。Swagger2 提供了一个交互式的 UI,使得开发人员能够测试、浏览和理解 API。下面将...