springfox

SwaggerUi就是自动生成接口文档的这么一个类似于插件的工具，可以直接访问接口。 首先打开pom文件，将插件引进来，然后增加一个属性<properties>，用来设置版本号的，然后直接用${}引用。 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <artifactId>JavaInterfaceTest</artifactId> <groupId>com.peixm.code</groupId> <version>1.0-SNAPSHOT</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>Chapter10</artifactId> <properties> <swagger.version>2.6.1</swagger.version> <

1.导入Maven依赖 < ! -- Swagger - UI API文档生产工具 -- > < dependency > < groupId > io . springfox < / groupId > < artifactId > springfox - swagger2 < / artifactId > < version > 2.7 .0 < / version > < / dependency > < dependency > < groupId > io . springfox < / groupId > < artifactId > springfox - swagger - ui < / artifactId > < version > 2.7 .0 < / version > < / dependency > 2.创建swaggerUI package com . example . demo . config ; import org . springframework . context . annotation . Bean ; import org . springframework . context . annotation . Configuration ; import springfox . documentation . builders .

1,引入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> 2,建立配置 @Configuration @EnableSwagger2 public class Swagger { @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.yangliwei.bootlaunch")) .paths(PathSelectors.regex("/rest/.*")) .build(); } public ApiInfo apiInfo() { return new

前言 swagger,中文“拽”的意思。它是一个功能强大的api框架，它的集成非常简单，不仅提供了在线文档的查阅， 而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api。 一、Swagger概述 Swagger是一组围绕OpenAPI规范构建的开源工具，可帮助设计、构建、记录和使用REST API。 简单说下，它的出现就是为了方便进行测试后台的restful形式的接口，实现动态的更新，当我们在后台的接口 修改了后，swagger可以实现自动的更新，而不需要认为的维护这个接口进行测试。 二、Swagger常用注解 swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 @Api：修饰整个类，描述Controller的作用 @ApiOperation：描述一个类的一个方法，或者说一个接口 @ApiParam：单个参数描述 @ApiModel：用对象来接收参数 @ApiProperty：用对象接收参数时，描述对象的一个字段 @ApiResponse：HTTP响应其中1个描述 @ApiResponses：HTTP响应整体描述 @ApiIgnore：使用该注解忽略这个API @ApiError ：发生错误返回的信息 @ApiParamImplicitL：一个请求参数 @ApiParamsImplicit 多个请求参数 三

疯狂创客圈 Java 高并发【 亿级流量聊天室实战】实战系列 【 博客园总入口 】 架构师成长+面试必备之 高并发基础书籍 【 Netty Zookeeper Redis 高并发实战 】 前言 Crazy-SpringCloud 微服务脚手架 &视频介绍 ： Crazy-SpringCloud 微服务脚手架，是为 Java 微服务开发 入门者 准备的 学习和开发脚手架。并配有一系列的使用教程和视频，大致如下： 高并发 环境搭建 图文教程和演示视频，陆续上线： 中间件 链接地址 Linux Redis 安装（带视频） Linux Redis 安装（带视频） Linux Zookeeper 安装（带视频） Linux Zookeeper 安装, 带视频 Windows Redis 安装（带视频） Windows Redis 安装（带视频） RabbitMQ 离线安装（带视频） RabbitMQ 离线安装（带视频） ElasticSearch 安装, 带视频 ElasticSearch 安装, 带视频 Nacos 安装（带视频） Nacos 安装（带视频） Crazy-SpringCloud 微服务脚手架 图文教程和演示视频，陆续上线： 组件 链接地址 Eureka Eureka 入门，带视频 SpringCloud Config springcloud Config 入门，带视频

现在很多项目都是前后端分离模式，所以在开发团队中经常需要写 API 文档，便于前后端开发对接。 若手写 API 文档，则有以下几个痛点： 文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。 文档编写需要单独占用时间，占用人力 接口文档太多，不好管理 不能直接在线测试接口，通常需要使用工具，比如 postman SpringBoot 项目整合 swagger2 插件，可以快速生成接口文档，便于测试接口。当然 swagger2 也有缺点，最明显的就是代码移入性比较强。下面简单介绍下如何在项目中使用 swagger2。 一、在 pom.xml 里面添加 jar 依赖 < dependency > < groupId > io.springfox < /groupId > < artifactId > springfox-swagger2 < /artifactId > < version > 2.8.0 < /version > < /dependency > < dependency > < groupId > io.springfox < /groupId > < artifactId > springfox-swagger-ui < /artifactId > < version > 2.8.0 < /version > < /dependency > 二

Maven依赖 < ! -- swagger api -- > < dependency > < groupId > io . springfox < / groupId > < artifactId > springfox - swagger2 < / artifactId > < version > 2.9 .2 < / version > < / dependency > < dependency > < groupId > io . springfox < / groupId > < artifactId > springfox - swagger - ui < / artifactId > < version > 2.9 .2 < / version > < / dependency > Docket配置 package org . sang . config ; import org . springframework . beans . factory . annotation . Value ; import org . springframework . context . annotation . Bean ; import org . springframework . context . annotation . Configuration ; import