`

springboot+swagger实现api文档

阅读更多

1.pom.xml配置

 

<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.5.0</version>
		</dependency>
<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.5.0</version>
		</dependency>
<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
			<scope>provided</scope>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

 2.java代码启用swagger配置

 

 

@EnableSwagger2
@Configuration
public class SwaggerConfig {
	@Bean
	public Docket getDocket() {
		return new Docket(DocumentationType.SWAGGER_2)
				//.groupName("v1")
				.genericModelSubstitutes(DeferredResult.class)
				.useDefaultResponseMessages(false)
				.forCodeGeneration(true)
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.auto.controller"))
				.build()
				.apiInfo(getApiInfo());
	}
	
	private ApiInfo getApiInfo() {
		Contact contact = new Contact("test", "http://www.test.com", "2251181679@qq.com");
		ApiInfo apiInfo = new ApiInfo("API接口",//大标题
				"REST风格API",//小标题
				"0.1",//版本
				"www.test.com",
				contact,//作者
				"主页",//链接显示文字
				""//网站链接
				);
		return apiInfo;
	}
}

 3.接口Controller  swagger配置

@RestController
@RequestMapping("/v1")
@Api(description="文件上传接口")
public class FileUploadController {
   	@RequestMapping(value="/upload", method=RequestMethod.POST)  
	@ApiOperation(value="上传文件到指定的路径下",response = ResponseObject.class, notes = "上传文件到指定的路径下")
	public  ResponseObject<Object> cpicUpload(@ApiParam(value="文件名称")@RequestParam(required=false) String name,  
			@ApiParam(value="文件",required=true)@RequestParam(required=true) MultipartFile file){  
		logger.info("进入上传文件接口,开始上传文件。。。。。。name:{}",name);
//自己逻辑
}

4.运行入口

@SpringBootApplication
public class AutoFileApplication extends SpringBootServletInitializer implements CommandLineRunner {
 
    @Override
    public void run(String... args) throws Exception {
         
    }
    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(AutoFileApplication.class);
    }
    public static void main(String[] args) {
        SpringApplication.run(AutoFileApplication.class, args);
    }
     
}

 

 

5.访问

http://localhost:8080/swagger-ui.html

 6.效果如下图



 

 

  • 大小: 66.1 KB
分享到:
评论

相关推荐

    springboot+swagger的一个小Demo

    Swagger2则作为一个插件,通过扫描SpringBoot应用中的Controller和相关注解,生成详细的API文档。开发者通常会在SpringBoot的启动类上添加@EnableSwagger2注解开启Swagger2的功能,然后定义一个Docket Bean来配置...

    springBoot+mysql+swagger练手demo.zip

    Swagger则为API文档的生成与管理提供了便利。本文将详细探讨如何将这三者结合,打造一个实用的练手项目。 一、SpringBoot框架介绍 SpringBoot是由Pivotal团队提供的全新框架,旨在简化Spring应用的初始搭建以及开发...

    springboot+myabtis+maven+swagger

    Swagger通过`@Api`, `@ApiOperation`, `@ApiParam`等注解,将接口的元数据与代码关联,自动生成API文档,方便前后端协作和API的版本控制。 在这个项目中,开发人员可能已经将Spring Boot与MyBatis集成,实现了...

    springboot+shiro+swagger2前后端分离整合

    这表明项目可能被组织成多个子模块,每个子模块负责不同的功能部分,如Spring Boot的主应用、Shiro的安全配置或者Swagger2的API文档生成。 结合这些组件,开发者可以创建一个安全、文档化的Web服务,前端通过调用...

    springboot+swagger3+mybatis-plus3.5.1代码生成+druid+log4j2【最完美】的一次配置

    Swagger3是一个强大的API文档生成工具,它可以自动生成RESTful API接口的文档,便于开发者理解和使用。在SpringBoot项目中集成Swagger3,我们可以使用`springfox-swagger2`和`springfox-swagger-ui`库,通过注解来...

    java springboot+swagger+mysql 框架案例,数据库mysql 5.7

    spring boot + swagger2集成api接口文档,springBoot+swagger+mysql 搭建的一个项目。可以启动。可供参考使用; Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是...

    springboot+dubbo+nacos+mybatisplus+swagger+mysql

    【标题】"springboot+dubbo+nacos+mybatisplus+swagger+mysql" 是一个集成性的技术栈,用于构建高效、可扩展的企业级微服务应用。这个项目整合了多个流行的开源框架,包括Spring Boot、Dubbo、Nacos、MyBatis Plus、...

    springboot+mybatis+swagger2实例

    【标题】"springboot+mybatis+swagger2实例"是一个集成应用,展示了如何在Spring Boot项目中结合MyBatis和Swagger2来实现数据库查询及API文档的自动化生成。在这个实例中,开发人员可以利用Spring Boot的快速开发...

    IDEA+Springboot+Mybatis+MySql+Swagger3.0+JWT权限验证 的实现 增、删、改、查

    我们主要利用IntelliJ IDEA作为开发集成环境(IDE),Spring Boot作为核心框架,Mybatis作为持久层框架,MySQL作为数据库存储,Swagger3.0用于API文档的生成与管理,以及JWT(JSON Web Tokens)进行权限验证,实现了...

    SpringBoot+Swagger3+log4j2

    Swagger3通过注解解析Java代码,自动生成API文档,提供交互式的UI,使得开发者和用户可以直观地了解和测试API。Swagger3支持OAuth2和其他安全协议,可以实现API的安全控制。在"默认地址:...

    springboot+mybatis+swagger框架

    Swagger还支持Swagger JSON格式,可以生成API文档,帮助团队协作和API管理。在Spring Boot项目中,通过添加Swagger的相关依赖,可以方便地为RESTful API提供详细的说明和测试平台。 集成这三个框架,开发者可以构建...

    java代码springboot+Swagger+redis+mybatis+restful代码案例(有文档)

    java代码springboot+Swagger+redis+mybatis+restful代码案例(有文档),写了三个版本的代码,都是简单的代码案例,有数据库设计,完成了表的增删改,关键是这几个技术都有锻炼到位,里面有三个案例,都是不同实现的,...

    SpringBoot+JPA+MySQL+Swagger+Redis实现CRUD

    通过SpringBoot简化开发流程,JPA提供ORM支持,MySQL作为数据存储,Swagger生成API文档,而Redis则提升系统的性能和响应速度。这样的组合不仅提升了开发效率,也为后续的维护和扩展提供了便利。

    springboot+druid+redis+swagger+security

    标题 "springboot+druid+redis+swagger+security" 提示了这个项目或者教程是关于使用Spring Boot框架,Druid数据源,Redis缓存,Swagger API文档,以及Spring Security安全框架的集成。以下是对这些技术的详细介绍:...

    springboot+swagger+版本控制

    SpringBoot结合Swagger与版本控制是现代微服务开发中常见的实践,用于构建清晰、可交互的API文档。在本文中,我们将深入探讨如何在SpringBoot项目中整合Swagger,并实现API的版本控制,解决Swagger页面不显示及JSON...

    基于springboot + swagger2 + jwt 搭建RESTful API框架+源代码+文档说明

    基于springboot + swagger2 + jwt 搭建RESTful API框架 # 目的 逐步完成基础框架和组件封装,能够快速新项目的开发 ## 项目备注 1、该资源内项目代码都经过测试运行成功,功能ok的情况下才上传的,请放心下载使用...

    springboot+jpa+swagger 动态查询

    Swagger UI可以实时展示API文档,并提供测试功能,帮助开发者快速验证API的行为。在Spring Boot中,我们可以通过集成Swagger2来轻松地管理和展示我们的API。 在“动态查询”方面,Spring Data JPA提供了Querydsl...

    springboot+swagger+版本控制 DEMO

    然后,利用Swagger的`@ApiVersion`注解来标记这些Controller,这样Swagger UI就能根据版本展示不同的API文档。 接下来,你需要在Spring Boot的配置文件(`application.yml`或`application.properties`)中启用Swagger...

    springboot+swagger2例子

    在SpringBoot项目中集成Swagger2,我们可以实现动态生成API文档,这大大提高了开发效率和协作的便利性。首先,我们需要在项目中添加Swagger2的依赖。在`pom.xml`文件中,添加如下依赖: ```xml &lt;groupId&gt;io....

    springboot +swagger2 小例子

    在这个"SpringBoot + Swagger2 小例子"中,我们将探讨如何将这两个工具结合使用,以便在SpringBoot项目中构建清晰、易于理解的API文档。 首先,要启用Swagger2,我们需要在SpringBoot项目的`pom.xml`文件中添加...

Global site tag (gtag.js) - Google Analytics