Swagger ApiModelProperty: Complete Guide

ApiModelProperty is an annotation in Swagger used to provide some explanations and constraints for API model properties.

The following information can be provided through the ApiModelProperty annotation:

1. Description: A brief summary of the attribute.
2. name: the name of the attribute.
3. The data type specifies the type of data for the property.
4. Permissible range of values for the attribute named “allowableValues”.
5. Detailed description of attributes.
6. Is the property mandatory?
7. Example value of the attribute.
8. Is the attribute hidden?

By using the ApiModelProperty annotation, developers can make API documentation more detailed and clear. They can read the API documentation to understand the meaning, constraints, and examples of each property. In addition, some Swagger integration tools (such as Swagger UI) can also generate forms based on the ApiModelProperty annotation to help users input the correct values.