openapi 3.1에서 3.0과 달라지는 점

nullable 타입의 교체

 

3.0에는 nullable을 선언하기 위해서 이렇게 선언해야했습니다

 

# OpenAPI v3.0
type: string
nullable: true

 

3.1에서는 이렇게 바뀝니다

 

여러개의 타입을 선언할수 있도록 바뀌고

 

null 이라는 타입을 선언할수 있도록 바뀌었습니다

 

null 이라는 타입이 생겨 복수의 타입을 지정할수 있게 되었기 때문에

 

더이상 nullable은 불필요합니다

 

그래서 nullable이 완전히 deprecate 되었습니다

# OpenAPI v3.1
type:
- "string"
- "null"

 

우리가 typescript에서 타입을 선언할때는

 

data: string | null

 

타입과 함께 null을 타입으로서 선언해주잖아요

 

좀 더 비슷한 느낌으로 설정할수 있게 되었습니다

 

 

 

example을 더 많이

 

# OpenAPI v3.0
type: string
example: fedora

example이 examples로 복수형으로 변경되며 더 많은 example을 넣을수 있도록 변경되었습니다

# OpenAPI v3.1
type: string
examples: 
 - fedora

 

example, examples 둘다 사용이 가능하고요 다만 examples를 사용하는 것을 추천합니다

 

 

그 외 추가변경사항은 여기서 확인하세요~

 

https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0

Migrating from OpenAPI 3.0 to 3.1.0 - OpenAPI Initiative