我有一个REST POST函数,其头部如下:
@POST
@Consumes(value = { MediaType.APPLICATION_JSON + ";charset=utf-8" })
@Produces(value = { MediaType.APPLICATION_JSON + ";charset=utf-8" })
@ApiOperation(value = "Create a document type", notes = "creates a document type from Json and returns the created type", response = Response.class)
@Session(roles = { Role.ROLE_ADMINISTRATOR })
@PublicApi
public Response create(
@ApiParam(value = "Created DocumentType", required = true)
@SwaggerDataType(type =
com.infor.daf.icp.internal.rest.models.DocumentType.class)
com.infor.daf.icp.internal.rest.models.DocumentType documentType) {
当我在Swagger UI中查看时,Swagger会创建一个示例请求主体。该主体包含
systemId (string, optional),
在模型视图中。systemId : "string"
在JSON视图中看到了一个名为systemId
的字段,但整个项目中没有这样的字段。我已经逐一检查了请求类及其祖先类,以及整个Java搜索项目。即使作为其他名称的子字符串,那个符号序列systemId
也没有出现。
Swagger从哪里获取该名称,我该如何停止它?因为我希望它创建一个有效的示例。
编辑:API函数本身可以正常接受JSON输入,并正确地组成了声明类的对象。
导入:
package com....documentarchive.rest.v1
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
Swagger UI看起来像这样:
编辑2。
我删除了@SwaggerDataType,或将其替换为@RequestBody,但奇怪的行为仍然存在。
我已将示例设置为显示具有实际数据的具体字符串:
@ApiParam(example = DOC_TYPE_EXAMPLE, value = "Created DocumentType", required = true) @RequestBody com.infor.daf.icp.internal.rest.models.DocumentType documentType) {
....
static final private String DOC_TYPE_EXAMPLE = "{'entityModel':\n" +
" {'name':'Anatemplate',\n" +
" 'desc':'Ana-template',\n" +
即使这样也没有帮助!Swagger仍然从互联网上某个遥远的文件(感谢@xpa1492提供参考)中生成一些无意义的字符串,而不是直接显示准备好的字符串。
更多编辑:
pom文件:https://drive.google.com/file/d/16fOCq5EFZYVBJRPg0HeiP102eRzEaH6W/view?usp=sharing