Open 2023/06/30にコメント追加 18

OpenAPI 3.0以上の仕様について

# 必須
# OpeｎAPIのどのバージョンを利用して記述しているかを定義する。 
# バージョンはセマンティックバージョニングで定義されており、記述もセマンティックバージョニングに従って記述する。
openapi: "3.0.0"
# APIのメタデータを定義する。
info:
# APIを提供するサーバーを配列で記述する。
servers:
# APIを整理するために利用するタグを定義する。 
tags:
# APIとして利用可能なパスおよび操作を定義する
paths:
# いろいろなオブジェクトをコンポーネントとして再利用可能な形で定義する。
components:

</span><a href="https://future-architect.github.io/articles/20200409/" style="" target="_blank" rel="nofollow noopener noreferrer">https://future-architect.github.io/articles/20200409/</a></p> <p>info自体は必須項目となる。</p> <li>titleは必須であり、文字列型を定義。APIのタイトルを入れる。</li> <li>descriptionは、文字列型を定義。APIに関する説明を定義する。マークダウンを使ってリッチテキスト表示もできる。</li> <li>versionは必須であり、文字列型を定義。記述している<code>API設計書（openapi.yaml自身）のバージョン</code>。</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">info</span><span class="token punctuation">:</span> <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">"Sample API"</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">"Sample API provides sample function."</span> <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">"1.0.0"</span> <a class="header-anchor-link" href="#servers" aria-hidden="true"/> servers</h2> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__73e981cdbe70e" src="https://embed.zenn.studio/card#zenn-embedded__73e981cdbe70e" data-content="https%3A%2F%2Fzenn.dev%2Flink%2Fcomments%2F8f32c1d06c2d84" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://zenn.dev/link/comments/8f32c1d06c2d84" style="" target="_blank">https://zenn.dev/link/comments/8f32c1d06c2d84</a></p> <li>1URIで１つのタグのみ定義する</li> <li>リソース名を単数形で記載する</li> <li>キャメルケース</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">postid</span><span class="token punctuation">:</span> <span class="token string">""</span> <span class="token key atrule">tag</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> product <span class="token comment"># GoアプリケーションのhandlerやTypeScriptのclassの単位となる</span> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">postid</span><span class="token punctuation">:</span> <span class="token string">""</span> <span class="token key atrule">tag</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> products <span class="token key atrule">postid</span><span class="token punctuation">:</span> <span class="token string">""</span> <span class="token key atrule">tag</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> user <span class="token punctuation">-</span> product </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-6712b27233fc0e"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-6712b27233fc0e"><time aria-label="2023年6月30日 10時25分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T01:25:40+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="operationid"> <a class="header-anchor-link" href="#operationid" aria-hidden="true"/> operationId</h2> <code>{HTTPメソッド}{機能物理名}</code>を記載する</li> <li>キャメルケース</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token comment"># GET /products</span> <span class="token key atrule">operationId</span><span class="token punctuation">:</span> getProducts <span class="token comment"># GET /products/:product_id</span> <span class="token key atrule">operationId</span><span class="token punctuation">:</span> getProductByProductId <span class="token comment"># POST /products</span> <span class="token key atrule">operationId</span><span class="token punctuation">:</span> postProducts <span class="token comment"># PUT /products/:product_id</span> <span class="token key atrule">operationId</span><span class="token punctuation">:</span> putProduct <span class="token comment"># DELETE /product/:product_id</span> <span class="token key atrule">operationId</span><span class="token punctuation">:</span> deleteProduct <a class="header-anchor-link" href="#description" aria-hidden="true"/> description</h2> <li>APIの機能概要を記載する。</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">description</span><span class="token punctuation">:</span> IDを指定して商品情報を取得する。 </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-c3d906e8b6b4bd"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-c3d906e8b6b4bd"><time aria-label="2023年6月30日 10時24分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T01:24:51+00:00" role="tooltip">2023/06/30</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="summary"> <a class="header-anchor-link" href="#summary" aria-hidden="true"/> summary</h2> <code>{機能ID} {機能論理名}</code>で定義する</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">summary</span><span class="token punctuation">:</span> XXX<span class="token punctuation">-</span>0001 商品参照 <a class="header-anchor-link" href="#security" aria-hidden="true"/> security</h2> <li>認証の要否で以下のように定義する</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">isAuthorized</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <a class="header-anchor-link" href="#oauth%E8%AA%8D%E8%A8%BC" aria-hidden="true"/> OAuth認証</h3> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">securityDefinitions</span><span class="token punctuation">:</span> <span class="token key atrule">isAuthorized</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> oauth2 <span class="token key atrule">flow</span><span class="token punctuation">:</span> accessCode <span class="token key atrule">authorizationUrl</span><span class="token punctuation">:</span> <span class="token string">'https://example.com/authorize'</span> <span class="token key atrule">tokenUrl</span><span class="token punctuation">:</span> <span class="token string">'https://example.com/.well-known/jwks.json'</span> </code></pre></div><p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__615f8f2c59e7" src="https://embed.zenn.studio/card#zenn-embedded__615f8f2c59e7" data-content="https%3A%2F%2Fqiita.com%2Fporuruba%2Fitems%2Fa384b34408fbba3b5e47" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://qiita.com/poruruba/items/a384b34408fbba3b5e47" style="" target="_blank" rel="nofollow noopener noreferrer">https://qiita.com/poruruba/items/a384b34408fbba3b5e47</a></p> </div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-895e16c99efcb8"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-895e16c99efcb8"><time aria-label="2023年6月30日 12時9分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T03:09:47+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="parameters"> <a class="header-anchor-link" href="#parameters" aria-hidden="true"/> parameters</h2> <p><code>parameters</code>の基本的な種類</p> <li>query</li> <li>header</li> <li>cookie</li> <a class="header-anchor-link" href="#get%2Fdelete-api-%E3%81%AE%E5%A0%B4%E5%90%88" aria-hidden="true"/> <code>GET/DELETE</code> API の場合</h3> <li>in: PATHはパラメータ</li> <li>in: queryはクエリパラメータ</li> <li>description: 必須</li> <li>name: 物理名を定義する <li>スネークケース</li> <li>原則略語は禁止</li> <li>type: arrayの場合、xxx_listやxxx_arrayはNGとする</li> <span class="token key atrule">description</span><span class="token punctuation">:</span> プロダクト種別 <span class="token punctuation">-</span> <span class="token key atrule">in</span><span class="token punctuation">:</span> query <span class="token key atrule">name</span><span class="token punctuation">:</span> defective_flag <span class="token comment"># trueとfalseがどちらの状態を示すのか不明瞭であるため非推奨</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> boolean <span class="token key atrule">description</span><span class="token punctuation">:</span> 不良品フラグ </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-0a22cc4bbc12c9"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-0a22cc4bbc12c9"><time aria-label="2023年6月30日 12時11分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T03:11:30+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h3 id="post%2Fput-api-%E3%81%AE%E5%A0%B4%E5%90%88"> <a class="header-anchor-link" href="#post%2Fput-api-%E3%81%AE%E5%A0%B4%E5%90%88" aria-hidden="true"/> <code>POST/PUT API</code> の場合</h3> <li>in: リクエストボディ <li>in: bodyのみ利用可能</li> <li>name: 全てname: bodyとする</li> <li>required: リクエストボディが必須でない場合を除いてrequired: trueを定義する</li> <li>schema: リクエストモデルをtype: objectで定義する</li> <p>※ <code>OAS3.0</code>からリクエストボディは<code>Request Body Object</code>としてParameterとは別の概念になったため、<code>in:body</code>と言う指定方法は廃止される。以下にリクエストボディの方法を示している。</p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__4781a2fc14ad" src="https://embed.zenn.studio/card#zenn-embedded__4781a2fc14ad" data-content="https%3A%2F%2Fzenn.dev%2Flink%2Fcomments%2F1d8555609432c0" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://zenn.dev/link/comments/1d8555609432c0" style="" target="_blank">https://zenn.dev/link/comments/1d8555609432c0</a></p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">parameters</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">in</span><span class="token punctuation">:</span> body <span class="token key atrule">name</span><span class="token punctuation">:</span> body <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token boolean important">true</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/definitions/postProductsRequest'</span> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">parameters</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">in</span><span class="token punctuation">:</span> body <span class="token key atrule">name</span><span class="token punctuation">:</span> postProductsBody <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token boolean important">false</span> <span class="token comment"># 不要</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token comment"># TypeScriptのInterfaceの自動生成時に型が適切に定義されない</span> <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">product_name</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <a class="header-anchor-link" href="#%E3%83%90%E3%83%AA%E3%83%87%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3" aria-hidden="true"/> バリデーション</h3> <li>required: 必須パラメータのみrequired: trueを定義する</li> <li>default: 必須でないパラメータでもデフォルト値がある場合は定義する</li> <li>type: 必須 <li>文字列：string</li> <li>数値：number</li> <li>整数値：integer</li> <li>ブール値：boolean</li> <li>配列：array</li> <li>オブジェクト：object</li> <code>type: array</code>の場合、<code>配列要素items</code>のtypeも必須</li> <code>type: null</code>は原則として利用しない</li> <li>複数のタイプを定義しない</li> <li>最大桁数：maxLength</li> <li>最小桁数：minLength</li> <li>数値または整数値 <li>最大値（境界値を含む）：maximum</li> <li>最小値（境界値を含む）：maximum</li> <li>境界値を含まない場合のみexclusiveMinimum: trueまたはexclusiveMaximum: trueを定義</li> <li>最大要素数：maxItems</li> <li>最小要素数：minItems</li> <li>required: trueの場合は原則としてminItems: 1を定義する</li> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> <span class="token string">'2020-01-31T23:59:59.000+09:00'</span> <span class="token key atrule">pattern</span><span class="token punctuation">:</span> '^((<span class="token punctuation">?</span><span class="token punctuation">:</span><span class="token punctuation">[</span>1<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token important">*)?</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">{</span><span class="token number">4</span><span class="token punctuation">}</span>)<span class="token punctuation">-</span>(1<span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">|</span>0<span class="token punctuation">[</span>1<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)<span class="token punctuation">-</span>(3<span class="token punctuation">[</span><span class="token number">01</span><span class="token punctuation">]</span><span class="token punctuation">|</span>0<span class="token punctuation">[</span>1<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">|</span><span class="token punctuation">[</span><span class="token number">12</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)T(2<span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">3</span><span class="token punctuation">]</span><span class="token punctuation">|</span><span class="token punctuation">[</span><span class="token number">01</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)<span class="token punctuation">:</span>(<span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">5</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)<span class="token punctuation">:</span>(<span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">5</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)(\.<span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)<span class="token punctuation">[</span>+<span class="token punctuation">|</span><span class="token punctuation">-</span><span class="token punctuation">]</span>(<span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">:</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span><span class="token punctuation">[</span>0<span class="token punctuation">-</span><span class="token number">9</span><span class="token punctuation">]</span>)$'` <li>ISO8601形式（hh:mm）とする</li> <code>example</code>: 23:59</li> <code>name</code>: 接尾辞_time</li> <code>type</code>: string</li> <code>pattern</code>: 必須</li> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">created_time</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> <span class="token datetime number">23:59</span> <span class="token key atrule">pattern</span><span class="token punctuation">:</span> <span class="token string">'^(2[0-3]|[01][0-9]):([0-5][0-9])$'</span> <p>正規表現で表現できる文字列はpatternを利用して定義すること</p> </div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-ffa159d0b804c3"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-ffa159d0b804c3"><time aria-label="2023年6月30日 10時58分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T01:58:16+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="responses"> <a class="header-anchor-link" href="#responses" aria-hidden="true"/> responses</h2> <a class="header-anchor-link" href="#get-api%E3%81%AE%E5%A0%B4%E5%90%88" aria-hidden="true"/> <code>GET API</code>の場合</h3> <a class="header-anchor-link" href="#description" aria-hidden="true"/> description</h4> <li>HTTPステータスコードのメッセージを記載すること</li> <a class="header-anchor-link" href="#schema" aria-hidden="true"/> schema</h4> <li>HTTPステータス：200の場合 <code>type: object</code>でレスポンスモデルを定義する</li> <code>required: 必須</code>で返る項目を定義する</li> <li>再利用可能なモデルを<code>definitions</code>配下に定義する <li>複合的なモデルを定義する場合は<code>allOf</code>を利用する</li> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/definitions/getProductsResponse'</span> <span class="token key atrule">examples</span><span class="token punctuation">:</span> <span class="token key atrule">application/json</span><span class="token punctuation">:</span> <span class="token comment"># Mockサーバのレスポンスになるためフロントエンド開発者も編集する</span> <span class="token key atrule">products</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">product_name</span><span class="token punctuation">:</span> Example Product <span class="token key atrule">create_date</span><span class="token punctuation">:</span> <span class="token string">'2020-01-01'</span> <span class="token key atrule">400</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> Bad Request <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/definitions/ErrorResponse'</span> <span class="token key atrule">500</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> Internal Server Error <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/definitions/ErrorResponse'</span> </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-b573ad59151072"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-b573ad59151072"><time aria-label="2023年6月30日 12時37分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T03:37:36+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h3 id="post%2Fput%2Fdelete-api%E3%81%AE%E5%A0%B4%E5%90%88"> <a class="header-anchor-link" href="#post%2Fput%2Fdelete-api%E3%81%AE%E5%A0%B4%E5%90%88" aria-hidden="true"/> <code>POST/PUT/DELETE API</code>の場合</h3> <a class="header-anchor-link" href="#description" aria-hidden="true"/> description</h4> <li>HTTPステータスコードのメッセージを記載すること</li> <a class="header-anchor-link" href="#schema" aria-hidden="true"/> schema</h4> <li>必要な場合は<code>type: object</code>でレスポンスモデルを定義する</li> <a class="header-anchor-link" href="#examples" aria-hidden="true"/> examples</h4> <li>schemaを定義した場合のみ記載する</li> <li>ステータスコード：200の場合のみapplication/jsonという命名で必須</li> <li>必須項目は必ず値を記載すること</li> </div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-bb971f8bd340fe"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-bb971f8bd340fe"><time aria-label="2023年6月30日 11時4分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T02:04:14+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="models"> <a class="header-anchor-link" href="#models" aria-hidden="true"/> models</h2> <a class="header-anchor-link" href="#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%83%A2%E3%83%87%E3%83%AB" aria-hidden="true"/> リクエストモデル</h3> <li>URI単位で1モデルを定義する</li> <li>キャメルケース</li> <code>postXxxxRequest</code>または<code>putXxxxRequest</code> <p>HTTPステータスコードの一覧と詳細は以下に詳しく載っている</p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__41411c83f0414" src="https://embed.zenn.studio/card#zenn-embedded__41411c83f0414" data-content="https%3A%2F%2Fdeveloper.mozilla.org%2Fja%2Fdocs%2FWeb%2FHTTP%2FStatus%2F200" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://developer.mozilla.org/ja/docs/Web/HTTP/Status/200" style="" target="_blank" rel="nofollow noopener noreferrer">https://developer.mozilla.org/ja/docs/Web/HTTP/Status/200</a></p> </div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-1d8555609432c0"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-1d8555609432c0"><time aria-label="2023年6月30日 11時35分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T02:35:13+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%83%9C%E3%83%87%E3%82%A3"> <a class="header-anchor-link" href="#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%83%9C%E3%83%87%E3%82%A3" aria-hidden="true"/> リクエストボディ</h2> <p>下記以外の方法でリクエストボディを送ることができる。こちらの方法が一般的になる。</p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__56a1e72de0196" src="https://embed.zenn.studio/card#zenn-embedded__56a1e72de0196" data-content="https%3A%2F%2Fzenn.dev%2Flink%2Fcomments%2F0a22cc4bbc12c9" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://zenn.dev/link/comments/0a22cc4bbc12c9" style="" target="_blank">https://zenn.dev/link/comments/0a22cc4bbc12c9</a></p> <p><code>/hoge</code>というpathに対してエンドポイントを作成する例</p> <a class="header-anchor-link" href="#multipart%2Fform-data" aria-hidden="true"/> multipart/form-data</h3> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token comment"># post/put/delete</span> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">multipart/form-data</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">foo</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">bar</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> integer <span class="token key atrule">baz</span><span class="token punctuation">:</span> <span class="token comment"># ファイル</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">format</span><span class="token punctuation">:</span> binary <a class="header-anchor-link" href="#json-%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88" aria-hidden="true"/> JSON リクエスト</h3> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token comment"># post/put/delete</span> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">application/json</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">foo</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">bar</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> integer <a class="header-anchor-link" href="#xml-%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88" aria-hidden="true"/> XML リクエスト</h3> <p>ここでは、後述のコンポーネントを利用して書いている。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">application/xml</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">"#/components/schemas/piyo"</span> <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">schemas</span><span class="token punctuation">:</span> <span class="token key atrule">piyo</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">foo</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">bar</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> integer <a class="header-anchor-link" href="#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89" aria-hidden="true"/> ファイルアップロード</h3> <p>jpeg ファイルアップロード</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">image/jpeg</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">format</span><span class="token punctuation">:</span> binary <a class="header-anchor-link" href="#%E7%94%BB%E5%83%8F-%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89" aria-hidden="true"/> 画像ファイルアップロード</h3> <p>サブタイプにアスタリスクも指定できる。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">image/*</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">format</span><span class="token punctuation">:</span> binary </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-8f32c1d06c2d84"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-8f32c1d06c2d84"><time aria-label="2023年6月30日 11時46分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T02:46:44+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC-(servers)"> <a class="header-anchor-link" href="#%E3%82%B5%E3%83%BC%E3%83%90%E3%83%BC-(servers)" aria-hidden="true"/> サーバー (servers)</h2> <p><code>API</code>が動いているサーバーの情報を記述できるほか、<code>Swagger UI</code> から API を試してみるときに使われる。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">servers</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">url</span><span class="token punctuation">:</span> https<span class="token punctuation">:</span>//example.com/api/v1 </code></pre></div><p>配列なので複数書くことができます。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">servers</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">url</span><span class="token punctuation">:</span> http<span class="token punctuation">:</span>//example.com/api/v1 <span class="token punctuation">-</span> <span class="token key atrule">url</span><span class="token punctuation">:</span> https<span class="token punctuation">:</span>//example.com/api/v1 </code></pre></div><p>複数プロトコルが存在する場合などに、<code>variables</code> を使って一つにまとめることができる。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">servers</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">url</span><span class="token punctuation">:</span> <span class="token string">"{protocol}://test{number}.example.com:{port}/api/v1"</span> <span class="token key atrule">variables</span><span class="token punctuation">:</span> <span class="token key atrule">protocol</span><span class="token punctuation">:</span> <span class="token key atrule">default</span><span class="token punctuation">:</span> https <span class="token key atrule">enum</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> http <span class="token punctuation">-</span> https <span class="token key atrule">number</span><span class="token punctuation">:</span> <span class="token key atrule">default</span><span class="token punctuation">:</span> <span class="token string">"1"</span> <span class="token key atrule">port</span><span class="token punctuation">:</span> <span class="token key atrule">default</span><span class="token punctuation">:</span> <span class="token string">"443"</span> <span class="token key atrule">enum</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token string">"443"</span> <span class="token punctuation">-</span> <span class="token string">"8080"</span> </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-efb42726b61b2b"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-efb42726b61b2b"><time aria-label="2023年6月30日 13時31分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T04:31:13+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="%E3%82%B3%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%8D%E3%83%B3%E3%83%88-(components)"> <a class="header-anchor-link" href="#%E3%82%B3%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%8D%E3%83%B3%E3%83%88-(components)" aria-hidden="true"/> コンポーネント (components)</h2> <p>コンポーネントは、<code>OpenAPI</code> の <code>yaml</code> 内で同じ構造が何度も出てくる場合に参照して使いまわせる仕組み。</p> <a class="header-anchor-link" href="#%E8%A4%87%E6%95%B0%E3%81%AEbody%E3%81%AE%E5%BD%A2%E5%BC%8F%E3%82%92%E3%82%B5%E3%83%9D%E3%83%BC%E3%83%88" aria-hidden="true"/> 複数のBodyの形式をサポート</h3> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">application/json</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">"#/components/schemas/piyo"</span> <span class="token key atrule">application/xml</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">"#/components/schemas/piyo"</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">schemas</span><span class="token punctuation">:</span> <span class="token key atrule">piyo</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">foo</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">bar</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string </code></pre></div><p>コンポーネントの実装方法のサンプルは以下が参考になる</p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__10277aea53ea5" src="https://embed.zenn.studio/card#zenn-embedded__10277aea53ea5" data-content="https%3A%2F%2Fwww.blog.danishi.net%2F2022%2F01%2F22%2Fpost-5758" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://www.blog.danishi.net/2022/01/22/post-5758" style="" target="_blank" rel="nofollow noopener noreferrer">https://www.blog.danishi.net/2022/01/22/post-5758</a></p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">schemas</span><span class="token punctuation">:</span> <span class="token comment"># 共通モデル</span> <span class="token key atrule">parameters</span><span class="token punctuation">:</span> <span class="token comment"># GET などで取得範囲を変更するときなどに利用</span> <span class="token key atrule">requestBodies</span><span class="token punctuation">:</span> <span class="token comment"># 共通で使う POST データ</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token comment"># 共通のレスポンス定義、 paths の中で利用</span> </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-962eed85714c8e"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-962eed85714c8e"><time aria-label="2023年6月30日 12時49分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T03:49:32+00:00" role="tooltip">2023/06/30に更新</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h3 id="securityschemes---%E8%AA%8D%E8%A8%BC"> <a class="header-anchor-link" href="#securityschemes---%E8%AA%8D%E8%A8%BC" aria-hidden="true"/> securitySchemes - 認証</h3> <p>認証情報は、<code>components</code> の中の <code>securityScheme</code>s の中に記述する。<br/> それを、認証が必要な要素の <code>security</code> キーから参照する。</p> <p><code>クッキー</code>を使った認証も書くことができますが、クッキーとして飛ばすキーと値は固定のものしか記述できず、セッション認証のようなことはできない。</p> <p>この辺の設定は複雑なので、こちらに詳しく書かれている。</p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__76d70bed3610b" src="https://embed.zenn.studio/card#zenn-embedded__76d70bed3610b" data-content="https%3A%2F%2Fgarafu.blogspot.com%2F2020%2F05%2Fhow-to-use-oas.html%23security-schemes" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://garafu.blogspot.com/2020/05/how-to-use-oas.html#security-schemes" style="" target="_blank" rel="nofollow noopener noreferrer">https://garafu.blogspot.com/2020/05/how-to-use-oas.html#security-schemes</a></p> <a class="header-anchor-link" href="#%E5%9F%BA%E6%9C%AC%E8%AA%8D%E8%A8%BC-(basic%E8%AA%8D%E8%A8%BC)" aria-hidden="true"/> 基本認証 (Basic認証)</h4> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">BasicAuth</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token comment"># 配列内は権限のスコープ。OAuth と OpenIDConnect 以外は空配列</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">securitySchemes</span><span class="token punctuation">:</span> <span class="token key atrule">BasicAuth</span><span class="token punctuation">:</span> <span class="token comment"># 任意の識別子</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> http <span class="token key atrule">scheme</span><span class="token punctuation">:</span> basic <a class="header-anchor-link" href="#oauth-%E8%AA%8D%E8%A8%BC" aria-hidden="true"/> OAuth 認証</h4> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">OAuth2</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> read <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">OAuth2</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> write <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">securitySchemes</span><span class="token punctuation">:</span> <span class="token key atrule">OAuth2</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> oauth2 <span class="token key atrule">flows</span><span class="token punctuation">:</span> <span class="token key atrule">authorizationCode</span><span class="token punctuation">:</span> <span class="token key atrule">authorizationUrl</span><span class="token punctuation">:</span> https<span class="token punctuation">:</span>//example.com/oauth/authorize <span class="token key atrule">tokenUrl</span><span class="token punctuation">:</span> https<span class="token punctuation">:</span>//example.com/oauth/token <span class="token key atrule">scopes</span><span class="token punctuation">:</span> <span class="token key atrule">read</span><span class="token punctuation">:</span> <span class="token string">"読み取り権限"</span> <span class="token key atrule">write</span><span class="token punctuation">:</span> <span class="token string">"書き込み権限"</span> <span class="token key atrule">create_review</span><span class="token punctuation">:</span> <span class="token string">"Post new review."</span> <a class="header-anchor-link" href="#%E3%82%AF%E3%83%83%E3%82%AD%E3%83%BC-(cookie)" aria-hidden="true"/> クッキー (Cookie)</h4> <p>APIのテストをするならサーバ側で、テスト用の固定のセッションIDを用意したりする必要がある。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">CookieAuth</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">securitySchemes</span><span class="token punctuation">:</span> <span class="token key atrule">CookieAuth</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> apiKey <span class="token key atrule">in</span><span class="token punctuation">:</span> cookie <span class="token key atrule">name</span><span class="token punctuation">:</span> SSID <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">bearer</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">securitySchemes</span><span class="token punctuation">:</span> <span class="token key atrule">bearer</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> http <span class="token key atrule">description</span><span class="token punctuation">:</span> JWT Token Authenticatio <span class="token key atrule">scheme</span><span class="token punctuation">:</span> bearer <span class="token key atrule">bearerFormat</span><span class="token punctuation">:</span> JWT <a class="header-anchor-link" href="#header---apikey" aria-hidden="true"/> Header - ApiKey</h4> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">apikey</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token comment">#-------------------------------</span> <span class="token comment"># Reusable security</span> <span class="token comment">#-------------------------------</span> <span class="token key atrule">securitySchemes</span><span class="token punctuation">:</span> <span class="token key atrule">apikey</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> apiKey <span class="token key atrule">name</span><span class="token punctuation">:</span> x<span class="token punctuation">-</span>api<span class="token punctuation">-</span>key <span class="token key atrule">in</span><span class="token punctuation">:</span> header <span class="token key atrule">description</span><span class="token punctuation">:</span> API Key Authentication <a class="header-anchor-link" href="#openidconnect" aria-hidden="true"/> OpenIDConnect</h4> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hoge</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">sample_oidc_auth</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">"200"</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> ok <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">securitySchemes</span><span class="token punctuation">:</span> <span class="token key atrule">sample_oidc_auth</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> openIdConnect <span class="token key atrule">openIdConnectUrl</span><span class="token punctuation">:</span> <span class="token string">"https://oidc.sample.com/signin"</span> </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-2ad618a33530e0"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-2ad618a33530e0"><time aria-label="2023年6月30日 12時29分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T03:29:16+00:00" role="tooltip">2023/06/30</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="%E3%83%87%E3%83%BC%E3%82%BF%E5%9E%8B"> <th>format</th> <th>description</th> <span class="token key atrule">post</span><span class="token punctuation">:</span> <span class="token key atrule">summary</span><span class="token punctuation">:</span> <span class="token string">"Get specified shop's reviews."</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">"Get specified shop's reviews."</span> <span class="token key atrule">tags</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> shops <span class="token key atrule">deprecated</span><span class="token punctuation">:</span> <span class="token boolean important">false</span> <span class="token key atrule">parameters</span><span class="token punctuation">:</span> <span class="token key atrule">requestBody</span><span class="token punctuation">:</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">security</span><span class="token punctuation">:</span> <a class="header-anchor-link" href="#path%E3%81%AEmethod%E3%81%AE%E7%A8%AE%E9%A1%9E" aria-hidden="true"/> pathのmethodの種類</h3> <li>delete</li> <li>options</li> <li>patch</li> <li>trace</li> <a class="header-anchor-link" href="#deprecated" aria-hidden="true"/> deprecated</h3> <p>廃止になった操作かどうかを定義する。<br/> デフォルト <code>false</code></p> </div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-f64df740a3b5b4"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-f64df740a3b5b4"><time aria-label="2023年6月30日 13時48分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T04:48:45+00:00" role="tooltip">2023/06/30</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="allof%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9"> <a class="header-anchor-link" href="#allof%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9" aria-hidden="true"/> allOfの使い方</h2> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">schemas</span><span class="token punctuation">:</span> <span class="token key atrule">Order</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">'注文'</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> order_id <span class="token punctuation">-</span> description <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">order_id</span><span class="token punctuation">:</span> <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">"注文 ID"</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> <span class="token string">"a1b2c3"</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">"注文に関するあれこれ"</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> <span class="token string">"24 -TWENTY FOUR- 10周年記念コンプリートDVD-BOX"</span> </code></pre></div><p>上記のようなレスポンスがあるします。<br/> 新規追加とかでリクエストパラメータとして指定する際に、必要な項目は以下の二つのどちらかになります。</p> <li><code>ユーザーの入力されたものを使う</code></li> <li><code>自動的に決まってくる項目になる</code></li> <p>前者はレスポンスパラメータとも共通で貼りますが、後者の項目（id とか作成日時とか）はまだ存在していません。</p> <p>ここで例えば、<code>リクエストボディ用のOrder</code>と<code>レスポンス用のOrder</code>に分ける、みたいな解決方法を取ってしまうと、段々と schema がコピペだらけになってきてしまい、行数がかなり増えて管理が大変になってきます。</p> <p>ここで<code>allOf</code>を使う。</p> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">schemas</span><span class="token punctuation">:</span> <span class="token key atrule">OrderId</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">'注文 ID'</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> order_id <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">order_id</span><span class="token punctuation">:</span> <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">'注文 ID'</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> <span class="token string">'a1b2c3'</span> <span class="token key atrule">OrderModel</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">'注文モデル'</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> description <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">'注文に関するあれこれ'</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> <span class="token string">'24 -TWENTY FOUR- 10周年記念コンプリートDVD-BOX'</span> <span class="token key atrule">OrderReponse</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">'注文'</span> <span class="token key atrule">allOf</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/components/schemas/OrderId'</span> <span class="token punctuation">-</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/components/schemas/OrderModel'</span> <span class="token key atrule">OrderRequest</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">'注文'</span> <span class="token key atrule">allOf</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">'#/components/schemas/OrderModel'</span> </code></pre></div><p>共通部分を、<code>OrderModel</code>としてくくり出してしまい、レスポンスとして返したいものは <code>OrderReponse</code> という名前にしておきます。<br/> ここで <code>allOf</code> を指定して、リスト形式で中で使われるものを全部列挙する。</p> <p>こうすることで、適切にマージされた schema を利用することができるようになります。</p> <a class="header-anchor-link" href="#allof%2C-anyof%2C-oneof%E3%81%AE%E9%81%95%E3%81%84" aria-hidden="true"/> allOf, anyOf, oneOfの違い</h3> <li>allOf</li> <li>anyOf</li> <li>oneOf</li> <a class="header-anchor-link" href="#allof" aria-hidden="true"/> allOf</h4> <p>array の中身<code>すべての schema に合致する</code>ことが条件。</p> <a class="header-anchor-link" href="#anyof" aria-hidden="true"/> anyOf</h4> <p>array のうち、<code>ひとつ以上の schema に合致する</code>ことが条件。</p> <a class="header-anchor-link" href="#oneof" aria-hidden="true"/> oneOf</h4> <p>array のうち、<code>必ずひとつの schema に合致する</code>ことが条件。<br/> anyOf と違い、array 中の<code>ふたつ以上の schema に合致してしまうとfail</code>する。</p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__ab49d21e199a1" src="https://embed.zenn.studio/card#zenn-embedded__ab49d21e199a1" data-content="https%3A%2F%2Fgirigiribauer.com%2Ftech%2F20190318" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://girigiribauer.com/tech/20190318" style="" target="_blank" rel="nofollow noopener noreferrer">https://girigiribauer.com/tech/20190318</a></p> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__d776923300e22" src="https://embed.zenn.studio/card#zenn-embedded__d776923300e22" data-content="https%3A%2F%2Ftamamemo.hatenablog.com%2Fentry%2F2015%2F07%2F09%2F224854" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://tamamemo.hatenablog.com/entry/2015/07/09/224854" style="" target="_blank" rel="nofollow noopener noreferrer">https://tamamemo.hatenablog.com/entry/2015/07/09/224854</a></p> </div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-6606b8cb3a1cda"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-6606b8cb3a1cda"><time aria-label="2023年6月30日 14時27分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T05:27:18+00:00" role="tooltip">2023/06/30</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h2 id="example%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9"> <a class="header-anchor-link" href="#example%E3%81%AE%E4%BD%BF%E3%81%84%E6%96%B9" aria-hidden="true"/> exampleの使い方</h2> <div class="code-block-container"><pre class="language-yml"><code class="language-yml"><span class="token key atrule">paths</span><span class="token punctuation">:</span> <span class="token key atrule">/hello</span><span class="token punctuation">:</span> <span class="token key atrule">get</span><span class="token punctuation">:</span> <span class="token key atrule">tags</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> hellos <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">'200'</span><span class="token punctuation">:</span> <span class="token key atrule">description</span><span class="token punctuation">:</span> 登録されている支払い方法が返される。 <span class="token key atrule">content</span><span class="token punctuation">:</span> <span class="token key atrule">application/json</span><span class="token punctuation">:</span> <span class="token key atrule">schema</span><span class="token punctuation">:</span> <span class="token key atrule">oneOf</span><span class="token punctuation">:</span> <span class="token punctuation">-</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">"#/components/responses/HelloResponse1"</span> <span class="token punctuation">-</span> <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">"#/components/responses/HelloResponse2"</span> <span class="token key atrule">examples</span><span class="token punctuation">:</span> <span class="token key atrule">response1</span><span class="token punctuation">:</span> <span class="token key atrule">summary</span><span class="token punctuation">:</span> HelloResponse1の通常レスポンスです <span class="token key atrule">value</span><span class="token punctuation">:</span> <span class="token key atrule">success1</span><span class="token punctuation">:</span> <span class="token key atrule">message_title</span><span class="token punctuation">:</span> Response1 <span class="token key atrule">message</span><span class="token punctuation">:</span> ハロー１のレスポンスのexampleです <span class="token key atrule">response2</span><span class="token punctuation">:</span> <span class="token key atrule">summary</span><span class="token punctuation">:</span> HelloResponseの特別なレスポンスです <span class="token key atrule">value</span><span class="token punctuation">:</span> <span class="token key atrule">success1</span><span class="token punctuation">:</span> <span class="token key atrule">message_title</span><span class="token punctuation">:</span> Response２ <span class="token key atrule">message</span><span class="token punctuation">:</span> ハロー２のレスポンスのexampleです <span class="token key atrule">components</span><span class="token punctuation">:</span> <span class="token key atrule">responses</span><span class="token punctuation">:</span> <span class="token key atrule">HelloResponse1</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">success1</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">msg_title</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> HelloResponse1 <span class="token key atrule">message</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> ハロー１のレスポンスです。 <span class="token key atrule">HelloResponse2</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">success1</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> object <span class="token key atrule">properties</span><span class="token punctuation">:</span> <span class="token key atrule">msg_title</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> HelloResponse2 <span class="token key atrule">message</span><span class="token punctuation">:</span> <span class="token key atrule">type</span><span class="token punctuation">:</span> string <span class="token key atrule">example</span><span class="token punctuation">:</span> ハロー２のレスポンスです。 </code></pre></div></div></div><footer class="ThreadItemContent_footer__WEMyQ"><div class="LikeButton_container__YlckE style-icon"><button aria-label="いいね" class="LikeButton_button__ZwdG4"><svg class="LikeButton_svgLike__Gl0Sz" viewbox="0 0 110 110"><path class="LikeButton_svgLikeLine__f9txR" d="M73,24a23.78,23.78,0,0,0-15.89,6.19,3.14,3.14,0,0,1-4.18,0A23.81,23.81,0,0,0,37,24a22,22,0,0,0-22,22c0,16.67,19.64,32.82,25.11,37.93,2.84,2.65,6.15,5.64,8.92,8.13a8.9,8.9,0,0,0,11.9,0c2.77-2.49,6.07-5.48,8.91-8.13C75.37,78.81,95,62.66,95,46A22,22,0,0,0,73,24Z" fill="currentColor"/><path class="LikeButton_svgLikeInner__uiexS" d="M66.25,76.42c-.71.64-1.32,1.2-1.82,1.67-2.51,2.33-5.39,5-7.94,7.25a2.21,2.21,0,0,1-3,0C51,83,48.1,80.42,45.59,78.09c-.5-.47-1.12-1-1.82-1.67C38.09,71.29,23,57.67,23,46A14,14,0,0,1,37,32a15.92,15.92,0,0,1,11.65,5.23l4.73,5a2.2,2.2,0,0,0,3.23,0l4.72-5A16.06,16.06,0,0,1,73,32,14,14,0,0,1,87,46C87,57.67,71.93,71.29,66.25,76.42Z" fill="currentColor"/><g class="LikeButton_svgLikeDecoration__78UjB"><circle cx="41.5" cy="9.5" fill="#3ea8ff" r="3.5"/><circle cx="98.5" cy="26.5" fill="#ffdc6e" r="3.5"/><circle cx="13" cy="19" fill="#c067f4" r="5"/><circle cx="77" cy="9" fill="#f76685" r="5"/><circle cx="26.5" cy="92.5" fill="#f76685" r="3.5"/><circle cx="105.5" cy="48.5" fill="#c067f4" r="3.5"/><circle cx="4.5" cy="60.5" fill="#3ea8ff" r="3.5"/><circle cx="94.5" cy="73.5" fill="#3ea8ff" r="1.5"/><circle cx="16.5" cy="75.5" fill="#ffdc6e" r="1.5"/><circle cx="78.5" cy="91.5" fill="#ffdc6e" r="1.5"/></g></svg></button></div></footer></div></article></div><div class="ScrapThread_item__zTzyN"><article class="ThreadItemContent_parentItem__2BweX" id="comment-780ddfd3055142"><header class="ThreadHeader_header__rscC4"><a class="ThreadHeader_userAvatar__zumMm ThreadItemContent_avatarContainer__xS_s_" href="/shimakaze_soft"><img alt="shimakaze_soft" class="AvatarImage_plain__Fgp4R " height="36" loading="lazy" referrerpolicy="no-referrer" src="https://res.cloudinary.com/zenn/image/fetch/s--hsbwYTN9--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_70/https://storage.googleapis.com/zenn-user-upload/avatar/96f9eb14ea.jpeg" width="36"/></a><a class="ThreadHeader_userName__TmgaQ" href="/shimakaze_soft">shimakaze_soft</a><a class="ThreadHeader_dateContainer__349dg" href="#comment-780ddfd3055142"><time aria-label="2023年6月30日 14時34分" data-tooltip-for-desktop="true" data-tooltip-position="top" datetime="2023-06-30T05:34:20+00:00" role="tooltip">2023/06/30</time></a><div class="ThreadHeader_actionContainer__8UItF"><button aria-label="メニューを開く" class="PopoverMenuButton_menuButton__hKCa_"><svg viewbox="0 0 27 27" height="16" width="16"><path fill="currentColor" d="M12.74,20.53,3.48,11.35a.75.75,0,0,1,0-1.07L4.71,9.05a.75.75,0,0,1,1.07,0l7.49,7.41,7.49-7.41a.74.74,0,0,1,1.06,0l1.24,1.23a.77.77,0,0,1,0,1.07L13.8,20.53A.74.74,0,0,1,12.74,20.53Z"/></svg></button></div></header><div class="ThreadItemContent_content__Ivb_O"><div class="InsertButtonToCodeBlock_insertButtonWrapper__ueql2"><div class="znc BodyCommentContent_bodyCommentContainer__5up6o"><h1 id="%E3%82%A8%E3%83%A9%E3%83%BC%E3%83%8F%E3%83%B3%E3%83%89%E3%83%AA%E3%83%B3%E3%82%B0%E3%81%AE%E3%83%99%E3%82%B9%E3%83%88%E3%83%97%E3%83%A9%E3%82%AF%E3%83%86%E3%82%A3%E3%82%B9"> <a class="header-anchor-link" href="#%E3%82%A8%E3%83%A9%E3%83%BC%E3%83%8F%E3%83%B3%E3%83%89%E3%83%AA%E3%83%B3%E3%82%B0%E3%81%AE%E3%83%99%E3%82%B9%E3%83%88%E3%83%97%E3%83%A9%E3%82%AF%E3%83%86%E3%82%A3%E3%82%B9" aria-hidden="true"/> エラーハンドリングのベストプラクティス</h1> <p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__71216686a102a" src="https://embed.zenn.studio/card#zenn-embedded__71216686a102a" data-content="https%3A%2F%2Fblog.restcase.com%2Frest-api-error-codes-101%2F" frameborder="0" scrolling="no" loading="lazy"/></span><a href="https://blog.restcase.com/rest-api-error-codes-101/" style="" target="_blank" rel="nofollow noopener noreferrer">https://blog.restcase.com/rest-api-error-codes-101/</a></p>