我有一个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仍会在互联网上的某个地方从一些遥远的file(感谢@ xpa1492作为参考)产生一些无意义的字符串,而不是简单地显示准备好的字符串。
更多编辑:
pom文件:https://drive.google.com/file/d/16fOCq5EFZYVBJRPg0HeiP102eRzEaH6W/view?usp=sharing
答案 0 :(得分:1)
似乎已经在这里得到回答:https://github.com/kongchen/swagger-maven-plugin/issues/608
Swagger配置未加载Jackson注释模块,忽略了所有使用的注释。因此,ApiReader正在读取错误的类(https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/DocumentType.html)。