嵌套实体类 RetPagedRowsVo,在嵌套的List rows的上边不要有ApiModelProperty注解,不然生成不了文档
时间: 2024-09-18 08:09:29 浏览: 20
根据数据库表和字段生成对应的实体文件(.cs)包含注释
嵌套实体类`RetPagedRowsVo`中,如果在包含`List<YourNestedEntity>`的`rows`字段上方没有`@ApiModelProperty`注解,Swagger默认不会生成对该列表的详细文档。为了显示`rows`内部元素的信息,你需要在`YourNestedEntity`类上添加适当的注解,以便让Swagger能够了解列表的内容。
例如,假设`YourNestedEntity`类如下:
```java
public class YourNestedEntity {
@ApiModelProperty("字段1")
private String field1;
// 其他字段和getter/setter
// 如果还有其他需要文档化的列表或其他嵌套结构,同样需要加上相应注解
}
```
然后在`RetPagedRowsVo`中,虽然不需要直接在`rows`上添加`@ApiModelProperty`,但可以提供一个简短的说明:
```java
public class RetPagedRowsVo {
private List<YourNestedEntity> rows; // 这里无需@ApiModelProperty
public List<YourNestedEntity> getRows() { /* getter */ }
public void setRows(List<YourNestedEntity> rows) { /* setter */ }
// 可能有的话,添加一个对rows列表的总体描述
@ApiModelProperty(value = "返回的一系列YourNestedEntity对象")
public List<YourNestedEntity> getRowsDescription() { return this.rows; }
}
```
这样,当你运行Swagger工具的时候,`rows`列表内部的字段就会作为子文档展示出来。
阅读全文