为什么 Swagger 在示例中创建了一个 systemId 字段?
Why Swagger created a systemId field in example?
我有一个 REST POST 函数,它具有以下 header:
@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 创建了一个示例请求 body。 body 有
systemId (string, optional),
在模型视图中
systemId : "string"
在 JSON 视图中。但是在整个项目中并没有一个名为systemId
的字段。我已经一一检查了请求 class 及其祖先,并通过搜索 Java 检查了整个项目。该符号序列 systemId
即使作为另一个名称的子字符串也不会出现。
Swagger 从哪里得到这个名字,我该如何阻止它?因为我当然希望它创建一个有效的示例。
编辑:API 函数本身可以毫无问题地接受 JSON 输入,并正确地组成声明的 class 的 object。
进口:
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;
招摇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
这里好像已经回答了:https://github.com/kongchen/swagger-maven-plugin/issues/608
Swagger 配置未加载 Jackson 注释模块,忽略了所有使用的注释。因此 ApiReader 读取错误 class (https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/DocumentType.html).
我有一个 REST POST 函数,它具有以下 header:
@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 创建了一个示例请求 body。 body 有
systemId (string, optional),
在模型视图中
systemId : "string"
在 JSON 视图中。但是在整个项目中并没有一个名为systemId
的字段。我已经一一检查了请求 class 及其祖先,并通过搜索 Java 检查了整个项目。该符号序列 systemId
即使作为另一个名称的子字符串也不会出现。
Swagger 从哪里得到这个名字,我该如何阻止它?因为我当然希望它创建一个有效的示例。
编辑:API 函数本身可以毫无问题地接受 JSON 输入,并正确地组成声明的 class 的 object。
进口:
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;
招摇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
这里好像已经回答了:https://github.com/kongchen/swagger-maven-plugin/issues/608
Swagger 配置未加载 Jackson 注释模块,忽略了所有使用的注释。因此 ApiReader 读取错误 class (https://docs.oracle.com/javase/8/docs/api/org/w3c/dom/DocumentType.html).