摘要：背景最近在做一个的项目，接口写的差不多了，后续大概要和前端对接。众所周知后端和前端的沟通是非常耗时和费力的，这时候有一个完善的接口文档会带来很大的帮助。就是一个非常好的选择。结果启动应用，访问查看接口文档。
背景
最近在做一个Spring Boot的项目，接口写的差不多了，后续大概要和前端对接。众所周知后端和前端的沟通是非常耗时和费力的，这时候有一个完善的接口文档会带来很大的帮助。Swagger就是一个非常好的选择。
添加依赖Gradle工程添加如下依赖：
compile("io.springfox:springfox-swagger-ui:2.6.1")
compile("io.springfox:springfox-swagger2:2.6.1")
Maven工程添加如下依赖：
io.springfox springfox-swagger-ui 2.6.1 compile io.springfox springfox-swagger2 2.6.1 compile
——————
修改代码为Applicaion类添加Swagger的注解：
@SpringBootApplication
@EnableSwagger2
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
创建一个配置类，防止将Spring默认的错误处理等接口放入文档中。
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).select()
.apis(Predicates.not(RequestHandlerSelectors.basePackage("org.springframework.boot")))
.build();
}
}
结果
启动应用，访问"/swagger-ui.html",查看接口文档。
甚至可以直接测试接口。
还是要善于使用各种开发工具。
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/67883.html
摘要：表示不一定是原生形式的数据。接口基于，继承了的功能并将其扩展使其支持用户系统上的文件。读取操作完成的时候，会变成已完成，并触发事件，同时属性将包含一个格式的字符串编码以表示所读取文件的内容。 温馨提示：这里除了一些幼稚的小组件啥也没有温馨提示-续：这是一个新的系列，写一些实际开发中遇到的一些常用的功能，想法笨拙，代码乱套 写在前面 图片上传，作为web端一个常用的功能，在不同的项目中有...
摘要：温馨提示这里除了一些幼稚的小组件啥也没有写在前面距离写完上一篇实践是检验程序员的唯一标准用户不想跟你说话并向你扔出一张图片图片上传组件开发思路篇过去了大半年，才开始写开发篇真的是令人悲哀，不过有句话说的好，开始做一件事最好的时间是大半年前 温馨提示：这里除了一些幼稚的小组件啥也没有 写在前面 距离写完上一篇实践是检验程序员的唯一标准01：用户不想跟你说话并向你扔出一张图片 - 图片上传...
摘要：但是这种手写文档带来的弊端就是维护起来苦不堪言，对于接口容易发生变化的开发者来说，维护文档就是噩梦好在现如今市场上书写文档的工具有很多，常见的有阿里的但是能称之为框架的，估计也只有了。 SpringBoot 是为了简化 Spring 应用的创建、运行、调试、部署等一系列问题而诞生的产物，自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖...
摘要：首先是从下载了，这个已经能够生成和文档了，但是对中文支持不好，中文大部分会显示为空白。关于这个对中文支持不好，查了很多资料，应该是字体和主题的原因，所以参考了很多资料，结合当前这个，做出了最终的能很好支持中文的，最终地址。 做后端开发，自然离不开接口文档，接口文档不仅方便后端开发人员之间查看，更是前端人员必要的文档，也有可能提供给第三方来调用我们的接口。但是，写接口文档太费时间，而且如...
摘要：集成生成接口文档原文简介由于的特性，用来开发变得非常容易，并且结合来自动生成文档变得方便快捷。使用生成，我们可以得到交互式文档。听过与的结合，生成更加完备的文档。接下来将基于与搭建完整的文档系统。 Spring Boot Swagger2 集成REST ful API 生成接口文档 原文 简介 由于Spring Boot 的特性，用来开发 REST ful 变得非常容易，并且结合 Sw...
阅读 964·2023-04-26 02:56
阅读 9437·2021-11-23 09:51
阅读 1849·2021-09-26 10:14
阅读 2979·2019-08-29 13:09
阅读 2153·2019-08-26 13:29
阅读 570·2019-08-26 12:02
阅读 3561·2019-08-26 10:42
阅读 2999·2019-08-23 18:18
