ApacheCamelREST请求POST的Body参数未在OpenAPI/Swagger文档中显示。
创始人
2024-09-05 14:01:29
0

可以使用Camel OpenAPI插件来生成OpenAPI规范文档并将其公开到Swagger UI中。为了在OpenAPI文档中显示POST请求的Body参数,需要将Camel OpenAPI插件配置为支持请求体参数。

以下是使用Camel OpenAPI插件和Camel Rest DSL定义REST服务的示例代码:

restConfiguration()
	.component("servlet")
	.bindingMode(RestBindingMode.auto)
	.dataFormatProperty("prettyPrint", "true")
	.contextPath("/api")
	.apiContextPath("/api-doc")
	.apiProperty("api.title", "User API")
	.apiProperty("cors", "true")
	.enableCORS(true)
	.port(8080)
	.host("localhost");

rest("/users").description("User REST service")
	.produces("application/json")
	.consumes("application/json")
	
	.post().description("Add a new user")
		.type(User.class)
		.param().name("body").type(body).description("The user to add").endParam()
		.outType(User.class)
		.route()
		    .to("bean:UserService?method=addUser")
		.endRest();

在POST请求中,我们使用了.type(User.class)定义请求体参数的类型,并使用.param()定义请求体参数。使用.outType(User.class)定义响应体参数的类型。

要在OpenAPI文档中显示请求体参数,需要使用.apiParam()定义OpenAPI参数。以下是示例代码:

.post().description("Add a new user")
	.type(User.class)
	.param().name("body").type(body).description("The user to add")
		.apiParam().name("user").type(User.class).description("User object").endParam()
	.endParam()
	.outType(User.class)
	.route()
		.to("bean:UserService?method=addUser")
	.endRest();

您应该能够在OpenAPI文档中看到相应的POST请求体参数。

相关内容

热门资讯

安卓系统怎么连不上carlif... 安卓系统无法连接CarLife的原因及解决方法随着智能手机的普及,CarLife这一车载互联功能为驾...
iwatch怎么连接安卓系统,... 你有没有想过,那款时尚又实用的iWatch,竟然只能和iPhone好上好?别急,今天就来给你揭秘,怎...
oppo手机安卓系统换成苹果系... OPPO手机安卓系统换成苹果系统:现实吗?如何操作?随着智能手机市场的不断发展,用户对于手机系统的需...
安卓平板改windows 系统... 你有没有想过,你的安卓平板电脑是不是也能变身成Windows系统的超级英雄呢?想象在同一个设备上,你...
iphone系统与安卓系统更新... 最近是不是你也遇到了这样的烦恼?手机更新系统总是失败,急得你团团转。别急,今天就来给你揭秘为什么iP...
安卓系统上滑按键,便捷生活与高... 你有没有发现,现在手机屏幕越来越大,操作起来却越来越方便了呢?这都得归功于安卓系统上的那些神奇的上滑...
安卓系统连接耳机模式,蓝牙、有... 亲爱的手机控们,你们有没有遇到过这种情况:手机突然变成了“耳机模式”,明明耳机没插,声音却只从耳机孔...
希沃系统怎么装安卓系统,解锁更... 亲爱的读者们,你是否也像我一样,对希沃一体机上的安卓系统充满了好奇呢?想象在教室里,你的希沃一体机不...
安装了Anaconda之后找不... 在安装Anaconda后,如果找不到Jupyter Notebook,可以尝试以下解决方法:检查环境...
安卓换鸿蒙系统会卡吗,体验流畅... 最近手机圈可是热闹非凡呢!不少安卓用户都在议论纷纷,说鸿蒙系统要来啦!那么,安卓手机换上鸿蒙系统后,...