程序包 springfox.documentation.builders

类 ResponseMessageBuilder

java.lang.Object

springfox.documentation.builders.ResponseMessageBuilder

public class ResponseMessageBuilder
extends Object

构造器概要

构造器

构造器	说明
ResponseMessageBuilder()

方法概要

修饰符和类型	方法	说明
ResponseMessage	build()
ResponseMessageBuilder	code(int code)	Updates the http response code
ResponseMessageBuilder	headers(Map<String,ModelReference> headers)	已过时。 Use the headersWithDescription(java.util.Map<java.lang.String, springfox.documentation.service.Header>) instead
ResponseMessageBuilder	headersWithDescription(Map<String,Header> headers)	Updates the response headers
ResponseMessageBuilder	message(String message)	Updates the response message
ResponseMessageBuilder	responseModel(ModelReference responseModel)	Updates the model the response represents
ResponseMessageBuilder	vendorExtensions(List<VendorExtension> extensions)	Updates the response message extensions

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ResponseMessageBuilder

public ResponseMessageBuilder()

方法详细资料

code

public ResponseMessageBuilder code(int code)

Updates the http response code

参数:

code - - response code

返回:

this

message

public ResponseMessageBuilder message(String message)

Updates the response message

参数:

message - - message

返回:

this

responseModel

public ResponseMessageBuilder responseModel(ModelReference responseModel)

Updates the model the response represents

参数:

responseModel - - model reference

返回:

this

headers

@Deprecated
public ResponseMessageBuilder headers(Map<String,ModelReference> headers)

已过时。

Use the headersWithDescription(java.util.Map<java.lang.String, springfox.documentation.service.Header>) instead

Updates the response headers

参数:

headers - header responses

返回:

this

从以下版本开始:

2.5.0

headersWithDescription

public ResponseMessageBuilder headersWithDescription(Map<String,Header> headers)

Updates the response headers

参数:

headers - headers with description

返回:

this

从以下版本开始:

2.5.0

vendorExtensions

public ResponseMessageBuilder vendorExtensions(List<VendorExtension> extensions)

Updates the response message extensions

参数:

extensions - - response message extensions

返回:

this

从以下版本开始:

2.5.0

build

public ResponseMessage build()