java加上swagger ui_SpringMVC、SpringFox和Swagger整合项目实例

最新推荐文章于 2021-03-13 19:49:03 发布
最新推荐文章于 2021-03-13 19:49:03 发布
阅读量178 收藏
点赞数
文章标签： java加上swagger ui
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39587010/article/details/114787224
版权

目标

在做项目的时候，有时候需要提供其它平台(如业务平台)相关的HTTP接口，业务平台则通过开放的HTTP接口获取相关的内容，并完成自身业务~

提供对外开放HTTP API接口，比较常用的是采用Spring MVC来完成。

本文的目标是先搭建一个简单的Spring MVC应用，然后为Spring MVC整合SpringFox-Swagger以及SpringFox-Swagger-UI，最终，达到Spring MVC对外开放接口API文档化。

如下图所示：

b062bdf266ea1db57f4721e6844cd517.png

搭建SpringMVC工程

新建Maven工程

Eclipse中，File --> New --> Maven Project，

3aa966f1204fd87f58a5e6bc3e3343a1.png

点击“Next”按钮， 然后选择 “maven-archetype-webapp”，

061f3b215a07ecdf9011443d96d8c98f.png

继续点击“Next”按钮，然后指定

98ac54a3fbb4ad3f19bd2f8fb01b1fdc.png

点击“Finish” 按钮结束~ 就这样，一个简单的Web工程就建好了~

2d17c93bc61c8311041539da91f7093c.png

但是，

默认是使用J2SE-1.5， 配置一下Build Path，使用本地机器上安装的JDK

(本文中使用的是JDK 1.7)，工程默认字体是GBK，将其改成UTF-8

完成后，Maven工程的结构如下图所示：

d007e448f4bb02688a3a7d7bd4c81ca0.png

引入Spring依赖包

在本示例中，因为简单，所以只要引入如下几个jar包就好了~

org.springframework

spring-core

${spring.framework.version}

org.springframework

spring-context

${spring.framework.version}

org.springframework

spring-webmvc

${spring.framework.version}

完整的pom.xml文件内容如下：

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

4.0.0

com.xxx.tutorial

springfox-swagger-demo

war

0.0.1-SNAPSHOT

springfox-swagger-demo Maven Webapp

http://maven.apache.org

UTF-8

4.3.6.RELEASE

org.springframework

spring-core

${spring.framework.version}

org.springframework

spring-context

${spring.framework.version}

org.springframework

spring-webmvc

${spring.framework.version}

springfox-swagger-demo

编写spring-mvc.xml文件

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"

xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:p="http://www.springframework.org/schema/p"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd

http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd

http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">

配置applicationContext.xml

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:p="http://www.springframework.org/schema/p"

xmlns:context="http://www.springframework.org/schema/context"

xsi:schemaLocation="http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans-4.3.xsd

http://www.springframework.org/schema/context

http://www.springframework.org/schema/context/spring-context-4.3.xsd">

配置web.xml

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"

version="3.1">

Archetype Created Web Application

org.springframework.web.context.ContextLoaderListener

contextConfigLocation

classpath:applicationContext.xml

springmvc

org.springframework.web.servlet.DispatcherServlet

contextConfigLocation

classpath:spring-mvc.xml

1

true

springmvc

/

encoding

org.springframework.web.filter.CharacterEncodingFilter

encoding

UTF-8

forceEncoding

true

encoding

/*

编写Controller并测试

配置好spring-mvc.xml、applicationContext.xml以及web.xml文件之后，咱们继续往下走~

因为，本文Spring MVC示例的作用主要用来暴露对外HTTP API接口，先写一个简单的ProductController，其包含一个按照id查询的方法。

Product.java和ProductController.java的内容如下：

Product.java

package com.xxx.tutorial.model;

import java.io.Serializable;

/**

*

* @author wangmengjun

*

*/

public class Product implements Serializable {

private static final long serialVersionUID = 1L;

/**ID*/

private Long id;

/**产品名称*/

private String name;

/**产品型号*/

private String productClass;

/**产品ID*/

private String productId;

/**

* @return the id

*/

public Long getId() {

return id;

}

/**

* @param id

* the id to set

*/

public void setId(Long id) {

this.id = id;

}

/**

* @return the name

*/

public String getName() {

return name;

}

/**

* @param name

* the name to set

*/

public void setName(String name) {

this.name = name;

}

/**

* @return the productClass

*/

public String getProductClass() {

return productClass;

}

/**

* @param productClass

* the productClass to set

*/

public void setProductClass(String productClass) {

this.productClass = productClass;

}

/**

* @return the productId

*/

public String getProductId() {

return productId;

}

/**

* @param productId

* the productId to set

*/

public void setProductId(String productId) {

this.productId = productId;

}

/*

* (non-Javadoc)

*

* @see java.lang.Object#toString()

*/

@Override

public String toString() {

return "Product [id=" + id + ", name=" + name + ", productClass=" + productClass + ", productId=" + productId

+ "]";

}

}

ProductController.java

package com.xxx.tutorial.controller;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

import com.xxx.tutorial.model.Product;

@RestController

@RequestMapping(value = { "/api/product/"})

public class ProductController {

@RequestMapping(value = "/{id}", method = RequestMethod.GET)

public ResponseEntity get(@PathVariable Long id) {

Product product = new Product();

product.setName("七级滤芯净水器");

product.setId(1L);

product.setProductClass("seven_filters");

product.setProductId("T12345");

return ResponseEntity.ok(product);

}

}

注：

鉴于是一个demo示例，所以没有写ProductService以及相关DAO, 直接在方法中返回固定的Product信息~

验证Spring MVC是否ok

完成Controller的代码，运行Spring MVC项目，然后，看一下Spring MVC是否运行ok，访问URL地址

http://localhost:8888/springfox-swagger-demo/api/product/1

出现错误

9a1a00fa11fe9d79e301b1837e1d4c62.png

详细的错误信息如下：

五月 23, 2017 3:00:55 下午 org.apache.catalina.core.StandardWrapperValve invoke

严重: Servlet.service() for servlet [spring-mvc] in context with path [/springfox-swagger-demo] threw exception [Request processing failed; nested exception is java.lang.IllegalArgumentException: No converter found for return value of type: class com.xxx.tutorial.model.Product] with root cause

java.lang.IllegalArgumentException: No converter found for return value of type: class com.xxx.tutorial.model.Product

at org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor.writeWithMessageConverters(AbstractMessageConverterMethodProcessor.java:187)

at org.springframework.web.servlet.mvc.method.annotation.HttpEntityMethodProcessor.handleReturnValue(HttpEntityMethodProcessor.java:203)

at org.springframework.web.method.support.HandlerMethodReturnValueHandlerComposite.handleReturnValue(HandlerMethodReturnValueHandlerComposite.java:81)

at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:132)

at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:827)

at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:738)

at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:85)

at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:963)

at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:897)

at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:970)

at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:861)

at javax.servlet.http.HttpServlet.service(HttpServlet.java:624)

at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:846)

at javax.servlet.http.HttpServlet.service(HttpServlet.java:731)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:303)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208)

at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:52)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208)

at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:197)

at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:107)

at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:241)

at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:208)

at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:220)

at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:122)

at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:170)

at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:103)

at org.apache.catalina.valves.AccessLogValve.invoke(AccessLogValve.java:957)

at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:116)

at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:423)

at org.apache.coyote.http11.AbstractHttp11Processor.process(AbstractHttp11Processor.java:1079)

at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:620)

at org.apache.tomcat.util.net.JIoEndpoint$SocketProcessor.run(JIoEndpoint.java:316)

at java.util.concurrent.ThreadPoolExecutor.runWorker(Unknown Source)

at java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source)

at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)

at java.lang.Thread.run(Unknown Source)

解决方法，添加jackson-databind依赖包即可~

com.fasterxml.jackson.core

jackson-databind

2.6.6

重新启动，运行一下，成功返回信息~

53a30b34dd3561c6e768b52e6ca29f2a.png

为了看的更加清楚，可以使用postman来完成~， 如~

6908aa9539e31843b0c29d0e8ec6d2e0.png

至此，一个简单的基于SpringMVC的Web项目已经创建，并能对外提供API接口~

4857fe6ae51417e7f4b6b09b3e09ca6f.png

接下来，我们要整合SpringFox和SwaggerUI到该SpringMVC项目中去，使其对外接口文档化

整合SpringFox-Swagger

SpringFox【

在SpringMVC项目中整合SpringFox-Swagger只要如下几步即可~

添加SpringFox-Swagger依赖

添加SwaggerConfig

添加依赖

io.springfox

springfox-swagger2

2.7.0

添加SwaggerConfig

package com.htjf.config;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import springfox.documentation.builders.ApiInfoBuilder;

import springfox.documentation.builders.RequestHandlerSelectors;

import springfox.documentation.service.ApiInfo;

import springfox.documentation.spi.DocumentationType;

import springfox.documentation.spring.web.plugins.Docket;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration

@EnableSwagger2

@ComponentScan(basePackages= {"com.htjf.controller"})

@EnableWebMvc

public class SwaggerConfig {

@Bean

public Docket api() {

return new Docket(DocumentationType.SWAGGER_2)

.select()

.apis(RequestHandlerSelectors.any())

.build()

.apiInfo(apiInfo());

}

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title("对外开放接口API 文档") //大标题 title

.description("HTTP对外开放接口") //小标题

.version("1.0.0") //版本

.termsOfServiceUrl("http://xxx.xxx.com") //终端服务程序

.license("LICENSE") //链接显示文字

.licenseUrl("http://xxx.xxx.com") //网站链接

.build();

}

}

整合SpringFox-Swagger-UI

在SpringMVC项目中整合SpringFox-Swagger-UI也只要如下两个步骤即可~

添加SpringFox-Swagger-UI依赖

添加配置

添加依赖

io.springfox

springfox-swagger-ui

2.7.0

添加配置

在添加配置之前，一起来看一下swagger-ui中使用的静态资源文件(如 swagger-ui.html)放在那里~

spingfox-swagger-ui-2.7.0.jar中的/META-INF/resources/下~ 如下图所示：

3b76e189f0d21641a7a4f3faf4110159.png

为了访问swagger-ui.html，我们配置对这些静态资源的访问~ 如：

package com.xxx.tutorial.config;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration

@EnableWebMvc

public class WebAppConfig extends WebMvcConfigurerAdapter {

@Override

public void addResourceHandlers(ResourceHandlerRegistry registry) {

registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");

}

}

该配置代码的效果和如下代码等价~

location="classpath:/META-INF/resources/webjars/" />

在本文中，可以将其配置在spring-mvc.xml中，

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"

xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:p="http://www.springframework.org/schema/p"

xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd

http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd

http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">

API接口说明代码添加并测试

经过上述几个步骤之后，之前写的ProductController的接口，就可以实现文档化了，如本文通过如下的访问地址访问：

http://localhost:8888/springfox-swagger-demo/swagger-ui.html

41e862dfa39c152e99ded5016b6d411a.png

这个接口API雏形出来了，但是还缺少点东西，比如：接口方法的描述等都没有~

修改一下，ProductController.java内容，如：

package com.xxx.tutorial.controller;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

import com.xxx.tutorial.model.Product;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

@RestController

@RequestMapping(value = { "/api/product/" })

@Api(value = "/product", tags = "Product接口")

public class ProductController {

@RequestMapping(value = "/{id}", method = RequestMethod.GET)

@ApiOperation(value = "根据id获取产品信息", notes = "根据id获取产品信息", httpMethod = "GET", response = Product.class)

public ResponseEntity get(@PathVariable Long id) {

Product product = new Product();

product.setName("七级滤芯净水器");

product.setId(1L);

product.setProductClass("seven_filters");

product.setProductId("T12345");

return ResponseEntity.ok(product);

}

}

重新访问，接口已经出现多个我们指定的描述信息~

91d0abac0bf251562c3bea63cf2bfccc.png

在参数id栏中输入1，然后点击“try it out”按钮~ 可以查看接口调用结果~

20307bbc6df9e778efc9ad2b74d58f04.png

至此一个简单的示例就完成了~

稍微增加几个接口

修改ProductController

package com.xxx.tutorial.controller;

import java.util.Arrays;

import java.util.List;

import org.springframework.http.ResponseEntity;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

import com.xxx.tutorial.model.Product;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiOperation;

import io.swagger.annotations.ApiResponse;

import io.swagger.annotations.ApiResponses;

@RestController

@RequestMapping(value = { "/api/product/" })

@Api(value = "/product", tags = "Product接口")

public class ProductController {

@RequestMapping(value = "/{id}", method = RequestMethod.GET)

@ApiResponses(value= {

@ApiResponse(code = 400,message="参数错误"),

@ApiResponse(code = 401,message="要求用户的身份认证"),

@ApiResponse(code = 403,message="拒绝执行此请求"),

@ApiResponse(code = 404,message="系统资源未发现"),

@ApiResponse(code = 500,message="系统错误"),

@ApiResponse(code = 200,message="成功,其它为错误,返回格式：{code:0,data[{}]},data中的属性参照下方Model",response=Product.class)})

@ApiOperation(value = "根据id获取产品信息", notes = "根据id获取产品信息", httpMethod = "GET")

public ResponseEntity get(@PathVariable Long id) {

Product product = new Product();

product.setName("七级滤芯净水器");

product.setId(1L);

product.setProductClass("seven_filters");

product.setProductId("T12345");

return ResponseEntity.ok(product);

}

@RequestMapping(method = RequestMethod.POST)

@ApiOperation(value = "添加一个新的产品")

@ApiResponses(value = {

@ApiResponse(code = 201,message="已创建。成功请求并创建了新的资源"),

@ApiResponse(code = 401,message="要求用户的身份认证"),

@ApiResponse(code = 403,message="拒绝执行此请求"),

@ApiResponse(code = 404,message="系统资源未发现"),

@ApiResponse(code = 405, message = "参数错误"),

@ApiResponse(code = 200,message="成功,其它为错误,返回格式：{code:0,data[{}]},data中的属性参照下方Model",response=String.class)})

public ResponseEntity add(Product product) {

return ResponseEntity.ok("SUCCESS");

}

@RequestMapping(method = RequestMethod.PUT)

@ApiOperation(value = "更新一个产品")

@ApiResponses(value = {

@ApiResponse(code = 200,message="成功,其它为错误,返回格式：{code:0,data[{}]},data中的属性参照下方Model",response=String.class),

@ApiResponse(code = 201,message="已创建。成功请求并创建了新的资源"),

@ApiResponse(code = 400, message = "参数错误"),

@ApiResponse(code = 401,message="要求用户的身份认证"),

@ApiResponse(code = 403,message="拒绝执行此请求"),

@ApiResponse(code = 404,message="系统资源未发现")})

public ResponseEntity update(Product product) {

return ResponseEntity.ok("SUCCESS");

}

@RequestMapping(method = RequestMethod.GET)

@ApiOperation(value = "获取所有产品信息", notes = "获取所有产品信息", httpMethod = "GET", response = Product.class, responseContainer = "List")

public ResponseEntity> getAllProducts() {

Product product = new Product();

product.setName("七级滤芯净水器");

product.setId(1L);

product.setProductClass("seven_filters");

product.setProductId("T12345");

return ResponseEntity.ok(Arrays.asList(product, product));

}

}

@RequestMapping(method=RequestMethod.DELETE)

@ApiOperation(value="删除某个产品信息",notes="删除某个产品信息")

/*@ApiImplicitParams(@ApiImplicitParam(name="carOwnerName",value="产品id",dataType="Long"))*/

@ApiResponses(value= {

@ApiResponse(code = 204,message="无内容。服务器成功处理，但未返回内容！"),

@ApiResponse(code = 400,message="参数错误"),

@ApiResponse(code = 401,message="要求用户的身份认证"),

@ApiResponse(code = 403,message="拒绝执行此请求"),

@ApiResponse(code = 500,message="系统错误"),

@ApiResponse(code = 200,message="成功,其它为错误,返回格式：{code:0,data[{}]},data中的属性参照下方Model",response=String.class)})

public ResponseEntity delete(@PathVariable Long id){

if(carOwnerName==null) {

return new ResponseEntity(HttpStatus.NO_CONTENT);

}else {

return ResponseEntity.ok("SUCCESS");

}

}

swagger-ui展示

b062bdf266ea1db57f4721e6844cd517.png

由上图可以看出，不同的method(GET / PUT / POST等)都会以不同的颜色展示出来~

Swagger-ui的添加，可以帮助他人查看接口信息，并在页面上进行输入参数来调用接口~

Maven工程的目录如下：

e9aa47140126358d60f726125f35b2c2.png

本文只是一个简单的整合示例，大家只要操作一下就能出来结果。

接下来讲解Swagger 常用注解使用

--@Api()用于类;

表示这个类是一个swagger的资源。它有两个属性，分别是：

String value();---也是说明，可以使用tags替代

String[] tags();---是一个数组，表示说明，tags如果有多个值，会生成多个list；

例如：

@Api(value="用户controller",tags={"用户操作接口"})

@RestController

public class UserController {

}

ui效果图：

2c6f9c11c73c8274ccf6684cb57b9b8b.png

--@ApiOperation()用于方法；

表示一个http请求的操作 ,它有4个常用属性：

String value();--用于方法描述；

String notes();--用于提示内容

String[] tags();--可以重新分组(视情况而用)

String httpMethod(); --请求方法类型，例如：httpMethod=“GET”;

--@ApiParam() 用于方法，参数，字段说明；表示对参数的添加元数据(说明或是否必填等) ,它有几个常用参数：

String name();--参数名

String value();--参数说明

boolean required();--是否必填

boolean allowEmptyValue();--是否允许有空值

例如：

@Api(value="用户controller",tags={"用户操作接口"})

@RestController

public class UserController {

@ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点")

@GetMapping("/getUserInfo")

public User getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) {

// userService可忽略，是业务逻辑

User user = userService.getUserInfo();

return user;

}

}

ui效果图：

36d5c2a1817b05d8c4d0be72819616a0.png

--@ApiModel()用于类 ；表示对类进行说明，用于参数用实体类接收

value–表示对象名

description–描述

都可省略

--@ApiModelProperty()用于方法，字段； 表示对model属性的说明或者数据操作更改

value–字段说明

name–重写属性名字

dataType–重写属性类型

required–是否必填

example–举例说明

hidden–隐藏

例如：

@ApiModel(value="user对象",description="用户对象user")

public class User implements Serializable{

private static final long serialVersionUID = 1L;

@ApiModelProperty(value="用户名",name="username",example="xingguo")

private String username;

@ApiModelProperty(value="状态",name="state",required=true)

private Integer state;

private String password;

private String nickName;

private Integer isDeleted;

@ApiModelProperty(value="id数组",hidden=true)

private String[] ids;

private List idList;

//省略get/set

}

@ApiOperation("更改用户信息")

@PostMapping("/updateUserInfo")

public int updateUserInfo(@RequestBody @ApiParam(name="用户对象",value="传入json格式",required=true) User user){

//注意，一定要添加@RequestBody注解

int num = userService.updateUserInfo(user);

return num;

}

ui效果图：

51dbb14f4e7ca912a6c69634ebfcca59.png

44fd748f5f26a7c5b2418bacadd7a3f1.png

--@ApiIgnore()用于类或者方法上，可以不被swagger显示在页面上

比较简单, 这里不做举例

--@ApiImplicitParam() 用于方法

表示单独的请求参数

@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

name–参数ming

value–参数说明

dataType–数据类型

paramType–参数类型

example–举例说明

*****在controller层使用@RequestParam的时候，发现这个参数是必须要输入值的，但是我们有时候必须查询的时候允许参数为空，使用这个注解就不行了。但是使用@ApiImplicitParam这个注解可以解决这个问题。

例如：

@ApiOperation("查询测试")

@GetMapping("select")

//@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query")

@ApiImplicitParams({

@ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"),

@ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")})

public void select(){

}

ui效果图：

691b3fa5599255e12384e35087dfdc9f.png

更加详细的文档，有兴趣的小伙伴可以访问swagger-ui的官网查看~

weixin_39587010
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Springfox Swagger UI
existent
06-19 3042
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/...
Swagger UI
12-04
Swagger UI
java使用原生swagger_Spring Boot 项目中使用Swagger2的示例
weixin_39752157的博客
03-08 155
本文介绍了Spring Boot 项目中使用Swagger2的示例，分享给大家，具体如下：添加Swagger2依赖在pom.xml中加入Swagger2的依赖io.springfoxspringfox-swagger22.2.2io.springfoxspringfox-swagger-ui2.2.2创建Swagger2配置类在Application.java同级创建Swagger2的配置类Swa...
java加上swagger ui_如何在JavaWeb项目中集成Springfox-Swagger-UI
weixin_31736005的博客
02-27 307
文章写的比较详细，实战过程中，遇到了两个问题，特别补充一下。1、报告异常：org.springframework.beans.factory.BeanCreationException:Errorcreatingbeanwithname'org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandler...
java ssm api接口,Java SSM添加Swagger接口文档
weixin_42126749的博客
03-13 262
1.需要的Jar包依赖io.springfoxspringfox-swagger22.7.0io.springfoxspringfox-swagger-ui2.7.0org.springframeworkspring-web4.3.14.RELEASE2.Swagger配置类import org.springframework.context.annotation.Bean;import org....
Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题
09-07
首先，要引入Swagger的相关依赖，需要在项目的`pom.xml`文件中添加Springfox的`springfox-swagger2`和`springfox-swagger-ui`两个依赖项，如下所示： ```xml <groupId>io.springfox <artifactId>springfox-...
SpringMVC使用的Swagger UI静态资源
12-28
压缩包中的 "ssm整合项目使用swagger-ui" 文件很可能包含了示例项目的源码，包括 Swagger 相关的配置、API 控制器及注解示例。通过研究这个项目，你可以更好地理解如何在实际的 SSM 项目中集成和使用 Swagger UI。 ...
springmvc与swagger swagger-ui 集成demo
06-22
标题 "springmvc与swagger swagger-ui 集成demo" 涉及到的是在Spring MVC框架下集成Swagger和Swagger-UI的技术实践。Spring MVC是Java Web开发中的一个流行框架，用于构建可重用、模块化的Web应用程序。Swagger则是...
springmvc与swagger整合使用的包 普通web项目的jar工程包
11-01
在IT行业中，SpringMVC和Swagger的整合是一个常见的需求，特别是在构建RESTful API服务时，为了提供清晰的接口文档和方便的API测试。SpringMVC是Spring框架的一部分，用于处理HTTP请求，而Swagger则是一个强大的工具...
swagger整合springMVC源码
10-10
首先，我们需要在Maven的`pom.xml`文件中引入Swagger的相关依赖，主要包含`springfox-swagger2`和`springfox-swagger-ui`两个库。它们分别用于生成Swagger的JSON定义和提供用户友好的UI界面。 ```xml <groupId>io...
swagger-ui
06-17
springmvc整合swagger的swagger-ui代码，确定可用，有问题欢迎留言
Swagger UI
周红伟讲AI
03-26 310
Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s autom...
swagger ui
Wangjunhe0819的博客
08-24 200
启动后端 http://localhost:8082/usm/swagger-ui.html#/
Swagger-UI 基于REST的API测试/文档类插件
lawliet的博客
08-26 828
现在多数的项目开发中，网站和移动端都需要进行数据交互和对接，这少不了使用REST编写API接口这种场景。例如我目前的工作，移动端交由了另一团队开发，不同开发小组之间就需要以规范和文档作为标准和协作基础。良好的文档可以让开发事半功倍，而作为又懒又要效率又能交代的码农，当然最希望一切自动化，或用小聪明来找到最适合的工具。 Swagger-UI简单而一目了然。它能够纯碎的基于html+javascri
Java【Java开发集成 Swagger UI生成可视图的API文档（详细图解）】
阿俊的博客
09-11 3723
目前几乎所有的开放平台都是把API以文档的形式放在网站上，如下： E1859779-2B51-4BA4-A078-A0CAE6E3D4C5.png 不知道有没有开发人员和我一样，有时对一些API说明的理解比较模糊，总想着能直接验证一下自己的理解就好了，而不是需要去项目写测试代码来验证自己的想法。即API文档应具备直接执行能力。 Swagger就是这样的一个利器，
Swagger-UI
Alan0517
01-30 345
随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要。没有API文档工具之前，大家都是手写API文档的，在什么地方书写的都有，而且API文档没有统一规范和格式，每个公司都不一样。这无疑给开发带来了灾难。
Spring Boot与springfox-swagger2整合打造RESTful API实战
return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.xingguo.springboot.controller")) // 指定扫描的包路径 .paths...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值