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.效果如下图
相关推荐
spring boot + swagger2集成api接口文档,springBoot+swagger+mysql 搭建的一个项目。可以启动。可供参考使用; Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是...
基于springboot + swagger2 + jwt 搭建RESTful API框架 # 目的 逐步完成基础框架和组件封装,能够快速新项目的开发 ## 项目备注 1、该资源内项目代码都经过测试运行成功,功能ok的情况下才上传的,请放心下载使用...
java代码springboot+Swagger+redis+mybatis+restful代码案例(有文档),写了三个版本的代码,都是简单的代码案例,有数据库设计,完成了表的增删改,关键是这几个技术都有锻炼到位,里面有三个案例,都是不同实现的,...
springboot整合swagger构建Api文档,对于整理在线文档这是一大利器,相对于ssm整合是真的简单方便,不管是不是新手,一看就能懂,对于与前端交互,那是相当的便捷。
如下所示,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加
在前后台分离的开发模式中,减小接口定义沟通成本,方便开发过程中测试,自动生成接口文档。
SpringBoot结合Swagger自动生成api文档.docx
Swagger2自动生成api文档界面http://localhost:8090/swagger-ui.html ## 前台代码(已经移除,单独放置到nginx服务器) 前台是vue,详细代码在33infobackend-vue里,此处已经打包放到resource/static目录下,配置好...
今天小编就为大家分享一篇关于SpringBoot+Swagger-ui自动生成API文档,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
【项目说明】 1.项目代码均经过功能验证ok,确保稳定可靠运行。...Swagger:API 文档生成工具 ## 前端 Vue.js:构建前端单页面应用 Element UI:基于 Vue.js 的前端 UI 框架 Axios:前端与后端的交互工具
前端: Jsp + Layui版本2.6.8 Jquery 版本jquery-2.1.1.min.js 图标使用阿里图标库下载的(可自己更换) ...API文档管理使用swagger2.7.0 、fasterxml 2.8.0 框架已使用AOP切面及开启cglib代理实现日志数据库存储
springboot框架+Swagger2Api接口文档生成工具,里面有2个查询示例。 运行项目后,http://localhost:8080/doc.html或者http://localhost:8080/swagger-ui.html,推荐使用第一个。第一个比较直观。数据库自己建立一下...
使用maven+springboot+swagger3+idea生成swagger API文档的演示示例。
此项目为前后端分离项目,后端API接口为SpringBoot项目;前端为vue项目; 环境需要 1.运行环境:最好是java jdk 1.8,我们在这个平台上运行的。其他版本理论上也可以。 2.IDE环境:IDEA,Eclipse,Myeclipse都可以。...
Swagger是全球最大的开源API规范(OAS)API开发工具框架,支持从设计和文档到测试和部署的整个API生命周期的开发。本篇只介绍如何在Spring boot项目中使用Swagger2,自动为API生成注释和规范API。
优势 严格遵循阿里编码规约开发,便于阅读及二次开发 支持 MySQL、MariaDB、Oracle、DB2、...自定义实现swagger文档支持,方便编写API接口文档 使用Mybatis拦截器实现数据权限,对代码侵入小 完成Activiti6集成,可实现
【资源说明】 1、基于springboot+mongodb搭建的简约个人博客系统源码+项目说明.zip 2、该资源包括项目的全部源码,下载可以直接使用!... - Api文档:swagger2 - 对象存储空间:七牛云 - 跨域认证:jwt ## 项目构建
接口文档 knife4j, knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案 有任何问题都 - 不懂运行,下载完可以私聊问,可远程教学 该资源内项目源码是个人的毕设,代码都测试ok,都是运行成功后才上传资源...