<div id="readability-page-1" class="page"><article id="mainContent">
                <div>
                  <p><a href="/m/category/BACKEND"><span>BACKEND</span></a></p><h3>openapi 3.1에서 3.0과 달라지는 점</h3>
                </div>
                <p><cite>나를찾는아이</cite>
                  <span> 2023. 5. 4. 12:09</span>
                </p>
                
            
                <div>
                                <h2 data-ke-size="size26">nullable 타입의 교체</h2>

<p data-ke-size="size16">3.0에는 nullable을 선언하기 위해서 이렇게 선언해야했습니다</p>

<pre id="code_1683168852797" data-ke-language="typescript" data-ke-type="codeblock"><code># OpenAPI v3.0
type: string
nullable: true</code></pre>

<p data-ke-size="size16">3.1에서는 이렇게 바뀝니다</p>

<p data-ke-size="size16">여러개의 타입을 선언할수 있도록 바뀌고</p>

<p data-ke-size="size16">null 이라는 타입을 선언할수 있도록 바뀌었습니다</p>

<p data-ke-size="size16">null 이라는 타입이 생겨 복수의 타입을 지정할수 있게 되었기 때문에</p>

<p data-ke-size="size16">더이상 nullable은 불필요합니다</p>

<p data-ke-size="size16">그래서 nullable이 완전히 deprecate 되었습니다</p>
<pre id="code_1683168870932" data-ke-language="typescript" data-ke-type="codeblock"><code># OpenAPI v3.1
type:
- "string"
- "null"</code></pre>

<p data-ke-size="size16">우리가 typescript에서 타입을 선언할때는</p>

<pre id="code_1683168911476" data-ke-language="typescript" data-ke-type="codeblock"><code>data: string | null</code></pre>

<p data-ke-size="size16">타입과 함께 null을 타입으로서 선언해주잖아요</p>

<p data-ke-size="size16">좀 더 비슷한 느낌으로 설정할수 있게 되었습니다</p>



<h2 data-ke-size="size26">example을 더 많이</h2>

<pre id="code_1683169457726" data-ke-language="typescript" data-ke-type="codeblock"><code># OpenAPI v3.0
type: string
example: fedora</code></pre>
<p data-ke-size="size16">example이 examples로 복수형으로 변경되며 더 많은 example을 넣을수 있도록 변경되었습니다</p>
<pre id="code_1683169474989" data-ke-language="typescript" data-ke-type="codeblock"><code># OpenAPI v3.1
type: string
examples: 
 - fedora</code></pre>

<p data-ke-size="size16">example, examples 둘다 사용이 가능하고요 다만 examples를 사용하는 것을 추천합니다</p>


<p data-ke-size="size16">그 외 추가변경사항은 여기서 확인하세요~</p>

<p data-ke-size="size16"><a href="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0" target="_blank" rel="noopener">https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0</a></p>
<figure id="og_1683169635610" contenteditable="false" data-ke-type="opengraph" data-ke-align="alignCenter" data-og-type="article" data-og-title="Migrating from OpenAPI 3.0 to 3.1.0 - OpenAPI Initiative" data-og-description="This post is authored by Phil Sturgeon, product manager, Stoplight, and Chairperson, Protect Earth. If you’d like to donate to Phil’s charity of choice, please see Protect Earth which is..." data-og-host="www.openapis.org" data-og-source-url="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0" data-og-url="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0" data-og-image="https://scrap.kakaocdn.net/dn/nALJR/hySvzBaOc0/3tiznZ7kjijwUaYgyTPYuk/img.png?width=1600&amp;height=900&amp;face=0_0_1600_900"><a href="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0" target="_blank" rel="noopener" data-source-url="https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0">

<div>
<p data-ke-size="size16">Migrating from OpenAPI 3.0 to 3.1.0 - OpenAPI Initiative</p>
<p data-ke-size="size16">This post is authored by Phil Sturgeon, product manager, Stoplight, and Chairperson, Protect Earth. If you’d like to donate to Phil’s charity of choice, please see Protect Earth which is...</p>
<p data-ke-size="size16">www.openapis.org</p>
</div>
</a><img src="https://scrap.kakaocdn.net/dn/nALJR/hySvzBaOc0/3tiznZ7kjijwUaYgyTPYuk/img.png?width=1600&amp;height=900&amp;face=0_0_1600_900"></figure>

            
            
                </div>
            

                
              </article></div>

나를 찾는 아이

Kyoung min, Kim

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

openapi 3.1에서 3.0과 달라지는 점

댓글