昂首阔步注解@ApiModel和@ApiModelProporty不显示值

时间:2019-08-30 13:09:01

标签: java rest swagger

我想记录我的模型,但是大摇大摆的注释无法正常工作。我正在使用osgi btw。

在Rest界面中,即时通讯使用:

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;

当我转到Swagger编辑器时,它的工作就很好了,说明出现了。

但是当我使用:

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

不起作用。我必须大摇大摆地编辑器,然后在其中粘贴de yaml,字段/模型上没有描述。

我使用依赖项:

    <dependency>
        <groupId>io.swagger</groupId>
        <artifactId>swagger-annotations</artifactId>
        <version>1.5.0</version>
        <scope>provided</scope>
    </dependency>

示例我如何使用: 型号:

@ApiModel(description = "foo - extends FooBase", parent = 
FooBase.class)
public class foo extends FooBase {

属性:

@ApiModelProperty(value = "description")
private String typeDescription;

它在Yaml上的显示方式:

 "typeDescription" : {
        "type" : "string"
      },

swagger ui:

typeDescription string

我认为继承也不起作用,因为在swagger编辑器中,FooBase在swagger编辑器中显示如下:

FooBase:
  type: object
  properties:
    id:
      type: string
    description:
      type: string
  discriminator:
    propertyName: type
CreateFooBaseRequest:
  type: object
  properties:
    fooBase:
      $ref: '#/components/schemas/FooBase'
CreateFooBaseResponse:
  type: object
  properties:
    fooBase:
      $ref: '#/components/schemas/FooBase'

但是在扩展FooBase的Foo类中,它出现:

allOf:
    - $ref: '#/components/schemas/FooBase'

有2个类扩展FooBase。例如:

@ApiModel(description = "foo",
    subTypes = {Foo.class, FooTwo.class})

请注意,这是一个示例...

但它不起作用...

0 个答案:

没有答案