springfox.documentation.builders.ResponseMessageBuilder Java Examples

The following examples show how to use springfox.documentation.builders.ResponseMessageBuilder. You can vote up the ones you like or vote down the ones you don't like, and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.

Example #1

Source File: ApiMethodReader.java From swagger-more with Apache License 2.0

6 votes

private void readReturnDescription(OperationContext context, ApiMethod apiMethod) {
    ResolvedType returnType = context.alternateFor(context.getReturnType());
    String message = StringUtils.isEmpty(apiMethod.returnDescription()) ? "成功" : apiMethod.returnDescription();
    ModelReference modelRef = null;
    if (!isVoid(returnType)) {
        ModelContext modelContext = ModelContext.returnValue(
                context.getGroupName(), returnType,
                context.getDocumentationType(),
                context.getAlternateTypeProvider(),
                context.getGenericsNamingStrategy(),
                context.getIgnorableParameterTypes());
        modelRef = modelRefFactory(modelContext, typeNameExtractor).apply(returnType);
    }
    ResponseMessage built = new ResponseMessageBuilder()
            .code(HttpStatus.OK.value())
            .message(message)
            .responseModel(modelRef)
            .build();
    context.operationBuilder().responseMessages(newHashSet(built));
}

Example #2

Source File: SwaggerConfig.java From tutorials with MIT License

6 votes

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).select()
        .apis(RequestHandlerSelectors.basePackage("com.baeldung.web.controller"))
        .paths(PathSelectors.ant("/foos/*"))
        .build()
        .apiInfo(apiInfo())
        .useDefaultResponseMessages(false)
        .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500)
            .message("500 message")
            .responseModel(new ModelRef("Error"))
            .build(),
            new ResponseMessageBuilder().code(403)
                .message("Forbidden!!!!!")
                .build()));
}

Example #3

Source File: SuccessPlugin.java From BlogManagePlatform with Apache License 2.0

6 votes

@Override
public void apply(OperationContext context) {
	//TODO:这样做屏蔽了@ResponseHeader的功能,因为没有了该注解。
	//由于本项目header为统一配置,故未实现替代功能。有必要的话需要提供一个替代实现。
	if (context.findAnnotation(ApiResponses.class).isPresent()) {
		return;
	}
	Optional<Success> annotation = context.findAnnotation(Success.class);
	if (!annotation.isPresent()) {
		context.operationBuilder().responseMessages(okResponses);
		return;
	}
	ResponseMessageBuilder messageBuilder = new ResponseMessageBuilder();
	messageBuilder.code(HttpStatus.OK.value());
	messageBuilder.message(okMessage);
	ModelReference model = resolveModel(context, annotation.get());
	messageBuilder.responseModel(model);
	context.operationBuilder().responseMessages(Set.of(messageBuilder.build()));
}

Example #4

Source File: MockApplication.java From AuTe-Framework with Apache License 2.0

6 votes

@Bean
public Docket wiremockApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.regex(".*__admin.*"))
            .build()
            .pathMapping("/")
            .directModelSubstitute(LocalDate.class,
                    String.class)
            .alternateTypeRules(
                    newRule(typeResolver.resolve(DeferredResult.class,
                            typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
                            typeResolver.resolve(WildcardType.class)))
            .useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET,
                    newArrayList(new ResponseMessageBuilder()
                            .code(500)
                            .message("Http error 500")
                            .build()))
            .enableUrlTemplating(true);
}

Example #5

Source File: SwaggerConfig.java From pacbot with Apache License 2.0

6 votes

@Bean
public Docket userApi() {

	List<ResponseMessage> list = new java.util.ArrayList<>();
	list.add(new ResponseMessageBuilder().code(500).message("500 message").responseModel(new ModelRef("Result"))
			.build());
	list.add(new ResponseMessageBuilder().code(401).message("Unauthorized").responseModel(new ModelRef("Result"))
			.build());
	list.add(new ResponseMessageBuilder().code(406).message("Not Acceptable").responseModel(new ModelRef("Result"))
			.build());

	return new Docket(DocumentationType.SWAGGER_2)
		.apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.tmobile.pacman"))
		.paths(PathSelectors.any()).build()
		.securitySchemes(chooseSecuritSchema())
		.securityContexts(chooseSecurityContext())
		.globalResponseMessage(RequestMethod.GET, list).globalResponseMessage(RequestMethod.POST, list);
}

Example #6

Source File: SwaggerConfig.java From Raincat with GNU Lesser General Public License v3.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #7

Source File: SwaggerManualApiPlugin.java From java-starthere with MIT License

5 votes

private Set<ResponseMessage> responseMessages()
{
    return Set.of(new ResponseMessageBuilder().code(200)
                                              .message("OK")
                                              .responseModel(new ModelRef("TokenModel"))
                                              .build());
}

Example #8

Source File: SwaggerConfig.java From myth with Apache License 2.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #9

Source File: SwaggerConfig.java From myth with Apache License 2.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #10

Source File: SwaggerConfig.java From myth with Apache License 2.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #11

Source File: SwaggerConfig.java From myth with Apache License 2.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #12

Source File: SwaggerConfig.java From hmily with Apache License 2.0

5 votes

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #13

Source File: SwaggerConfig.java From hmily with Apache License 2.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #14

Source File: SwaggerConfig.java From Raincat with GNU Lesser General Public License v3.0

5 votes

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #15

Source File: SwaggerConfig.java From Raincat with GNU Lesser General Public License v3.0

5 votes

/**
 * Api docket.
 *
 * @return the docket
 */
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}

Example #16

Source File: Swagger2.java From oneplatform with Apache License 2.0

5 votes

/** 
 * 自定义返回信息 
 * @param 
 * @return 
 */  
private List<ResponseMessage> customerResponseMessage(){  
    return Arrays.asList(  
            new ResponseMessageBuilder()//500  
                    .code(9999)  
                    .message("系统繁忙")  
                    .responseModel(new ModelRef("Error"))  
                    .build(),  
            new ResponseMessageBuilder()//401  
                    .code(401)  
                    .message("未授权访问")  
                    .build());  
}

Example #17

Source File: MainController.java From steady with Apache License 2.0

5 votes

/**
 * <p>backendApi.</p>
 *
 * @return a {@link springfox.documentation.spring.web.plugins.Docket} object.
 */
@Bean
public Docket backendApi() {
	return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build().pathMapping("/")
			.apiInfo(new springfox.documentation.service.ApiInfo("Vulas CIA", "RESTful API for discovering and analyzing alternative Maven artifacts", "1.1.0-SNAPSHOT", "SAP", null, "commercial", null))
			.directModelSubstitute(LocalDate.class, String.class).genericModelSubstitutes(ResponseEntity.class)
			.alternateTypeRules(newRule(typeResolver.resolve(DeferredResult.class, typeResolver.resolve(ResponseEntity.class, WildcardType.class)), typeResolver.resolve(WildcardType.class)))
			.useDefaultResponseMessages(false)
			.globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message").responseModel(new ModelRef("Error")).build()));
	//.securitySchemes(newArrayList(apiKey())).securityContexts(newArrayList(securityContext()));
}

Example #18

Source File: SuccessPlugin.java From BlogManagePlatform with Apache License 2.0

5 votes

public SuccessPlugin(TypeNameExtractor typeNameExtractor, TypeResolver typeResolver, SwaggerProperties properties) {
	this.typeNameExtractor = typeNameExtractor;
	this.typeResolver = typeResolver;
	this.useCustomerizedPluggins = properties.getUseCustomerizedPluggins();
	okMessage = SwaggerUtil.statusDescription((item) -> {
		return item.getStatus() == HttpStatus.OK;
	});
	ResponseMessageBuilder messageBuilder = new ResponseMessageBuilder();
	messageBuilder.code(HttpStatus.OK.value());
	messageBuilder.message(okMessage);
	messageBuilder.responseModel(new ModelRef(SwaggerModel.class.getSimpleName()));
	okResponses.add(messageBuilder.build());
	okResult = typeResolver.resolve(SwaggerModel.class);
}

Example #19

Source File: SwaggerConfig.java From BlogManagePlatform with Apache License 2.0

5 votes

/**
 * 全局返回信息
 * @author Frodez
 * @date 2019-06-06
 */
private List<ResponseMessage> getGlobalResponseMessage() {
	List<ResponseMessage> list = new ArrayList<>();
	Map<HttpStatus, List<Result.ResultEnum>> map = new HashMap<>();
	for (Result.ResultEnum item : Result.ResultEnum.values()) {
		if (item.getStatus() == HttpStatus.OK) {
			//成功的返回信息不设置默认
			continue;
		}
		if (map.containsKey(item.getStatus())) {
			map.get(item.getStatus()).add(item);
		} else {
			List<Result.ResultEnum> enumList = new ArrayList<>();
			enumList.add(item);
			map.put(item.getStatus(), enumList);
		}
	}
	for (Entry<HttpStatus, List<Result.ResultEnum>> entry : map.entrySet()) {
		String message = SwaggerUtil.statusDescription(entry.getValue());
		ResponseMessageBuilder messageBuilder = new ResponseMessageBuilder();
		messageBuilder.code(entry.getKey().value());
		messageBuilder.message(message);
		messageBuilder.responseModel(new ModelRef(SwaggerModel.class.getSimpleName()));
		list.add(messageBuilder.build());
	}
	return list;
}

Example #20

Source File: Swagger2Configuration.java From spring-cloud-gray with Apache License 2.0

5 votes

/**
 * 自定义返回信息
 *
 * @return 返回消息列表
 */
private List<ResponseMessage> customerResponseMessage() {

    return Arrays.asList(new ResponseMessageBuilder()//500
                    .code(500)
                    .message("")
                    .responseModel(new ModelRef("Error"))
                    .build(),
            new ResponseMessageBuilder()//401
                    .code(401)
                    .message("")
                    .build());
}

Example #21

Source File: JavadocBuilderPlugin.java From springfox-javadoc with Apache License 2.0

5 votes

@Override
public void apply(OperationContext context) {

    String notes = context.requestMappingPattern() + PERIOD + context.httpMethod().toString() + ".notes";
    if (StringUtils.hasText(notes) && StringUtils.hasText(environment.getProperty(notes))) {
        context.operationBuilder().notes("<b>" + context.getName() + "</b><br/>" + environment.getProperty(notes));
    }
    String returnDescription = context.requestMappingPattern() + PERIOD + context.httpMethod().toString()
      + ".return";
    if (StringUtils.hasText(returnDescription) && StringUtils.hasText(environment.getProperty(returnDescription))) {
        context.operationBuilder().summary("returns " + environment.getProperty(returnDescription));
    }
    String throwsDescription = context.requestMappingPattern() + PERIOD + context.httpMethod().toString()
      + ".throws.";
    int i = 0;
    Set<ResponseMessage> responseMessages = new HashSet<ResponseMessage>();
    while (StringUtils.hasText(throwsDescription + i)
      && StringUtils.hasText(environment.getProperty(throwsDescription + i))) {
        String[] throwsValues = StringUtils.split(environment.getProperty(throwsDescription + i), "-");
        if (throwsValues.length == 2) {
            // TODO[MN]: proper mapping once
            // https://github.com/springfox/springfox/issues/521 is solved
            String thrownExceptionName = throwsValues[0];
            String throwComment = throwsValues[1];
            ModelReference model = new ModelRef(thrownExceptionName);
            ResponseMessage message = new ResponseMessageBuilder().code(500).message(throwComment)
              .responseModel(model).build();
            responseMessages.add(message);
        }
        i++;
    }
    context.operationBuilder().responseMessages(responseMessages);

}

Example #22

Source File: App.java From cerebro with GNU Affero General Public License v3.0

4 votes

private List<ResponseMessage> responseMessageList() {
    return newArrayList(new ResponseMessageBuilder().code(500).message("Server Error").responseModel(new ModelRef("Error")).build(),
        new ResponseMessageBuilder().code(401).message("Unauthorized").build());
}