分析
注解
@ApiModel
使用场景:在实体类上边使用,标记类时swagger的解析类
什么是Swagger
OpenAPI规范(OpenAPI Specification 简称OAS)是Linux基金会的一个项目,试图通过定义一种用来描述API格式或API定义的语言,来规范RESTful服务开发过程,目前版本是V3.0,并且已经发布并开源在github上。
Swagger是符合OpenAPI规范的接口开发工具,支持从设计和文档到测试和部署的整个API生命周期的开发
作用范围 | API | 使用位置 |
---|---|---|
对象属性 | @ApiModelProperty | 用在出入参数对象的字段上 |
协议集描述 | @Api | 用于controller类上 |
协议描述 | @ApiOperation | 用在controller的方法上 |
Response集 | @ApiResponses | 用在controller的方法上 |
Response | @ApiResponse | 用在 @ApiResponses里边 |
非对象参数集 | @ApiImplicitParams | 用在controller的方法上 |
非对象参数描述 | @ApiImplicitParam | 用在@ApiImplicitParams的方法里边 |
描述返回对象的意义 | @ApiModel | 用在返回对象类上 |
@JsonNaming
@JsonNaming批注用于为序列化中的属性选择命名策略,覆盖默认设置。 使用value元素,我们可以指定任何策略,包括自定义策略。
除了默认值LOWER_CAMEL_CASE(例如lowerCamelCase)外,Jackson库还为我们提供了另外四种内置的属性命名策略,以方便使用:
KEBAB_CASE:名称元素之间用连字符分隔,例如 kebab-case。
LOWER_CASE:所有字母均为小写字母,没有分隔符,例如 lowercase。
LOWER_DOT_CASE:所有字母均为小写字母,用点连接字符,例如 lower.case。
SNAKE_CASE:所有字母均为小写,并在名称元素之间使用下划线作为分隔符,例如 snake_case。
UPPER_CAMEL_CASE:所有名称元素,包括第一个,都以大写字母开头,后跟小写字母,并且没有分隔符,例如 UpperCamelCase。
此示例将说明使用蛇形案例名称序列化属性的方法,其中将名为beanName的属性序列化为bean_name。
@ConfigurationProperties( prefix = ”xxxx” )
在 SpringBoot 中,当想需要获取到配置文件数据时,除了可以用 Spring 自带的 @Value 注解外,SpringBoot 还提供了一种更加方便的方式:@ConfigurationProperties。只要在 Bean 上添加上了这个注解,指定好配置文件的前缀,那么对应的配置文件数据就会自动填充到 Bean 中。
比如在application.properties文件中有如下配置文件
config.username=jay.zhou
config.password=3333