Anotaciones de uso común de Swagger @API, @ApiOperation, @ApiParam, etc.

Recientemente encontré un proyecto que usaba swagger para generar documentos de interfaz. Vi algunas anotaciones no utilizadas (@API, @ApiOperation, etc.) en el controlador e intenté registrarlas.

p >

@API

Anotaciones utilizadas en controladores (@API, @ApiParam, etc.). ), intente registrar

@API

usado en la clase, lo que indica que es un recurso arrogante, @API tiene dos atributos: valor, etiquetas, el código fuente es el siguiente

//Si no se utilizan etiquetas, este valor se utilizará para establecer la etiqueta para las operaciones descritas por este recurso.

String value() default "";

//Las etiquetas se pueden utilizar para agrupar lógicamente operaciones por recurso o cualquier otro calificador.

Cadena[] etiquetas() predeterminado {""}

1

2

3

4

5

Los documentos de API generados se clasificarán según las etiquetas. En pocas palabras, todas las interfaces en el controlador generarán documentos de interfaz bajo la etiqueta de lista si hay varios valores de etiquetas; , se generarán varias listas y cada lista mostrará todas las interfaces

@Api(tags = "list 1")

@Api(tags = {"list 1", "list 2 "})

1

2

El valor es similar a la etiqueta, pero no puede tener múltiples valores

@ApiOperation

Se utiliza para métodos para representar el funcionamiento de solicitudes http

Hay demasiados atributos en el código fuente, por lo que señalaré algunos atributos más utilizados

valor se utiliza para la descripción del método.

Los comentarios se usan para mensajes

Las etiquetas se pueden reagrupar (según corresponda)

@ApiParam

Se usa para métodos o parámetros, campo descripción; significa agregar metadatos para los parámetros (descripción o si es necesario, etc.).

nombre - nombre del parámetro

valor - descripción del parámetro

requerido-requerido o no

@ApiModel()

Usado para clases, indica la descripción de la clase, usado para recibir parámetros en clases de entidad

valor -descripción - descripción

@ApiModelProperty()

Usado para métodos y campos, usado para indicar la descripción de los atributos del modelo o cambios en las operaciones de datos

valor - la descripción del campo

nombre - el nombre del atributo sobrecargado

dataType -Tipo de atributo sobrecargado

requerido -Si es requerido

ejemplo -ejemplo

oculto-Oculto