OpenAPIで特定のAPIを使わないように明示したい

OpenAPIで使うな危険を示したいときのtips

例えばこんな時

• APIを削除・追加したいのでOpenAPIを修正しなければいけない
• OpenAPIで仕様共有をしているけど、一部のAPIを近い将来に廃止したい
• APIのパス設計を見直したので、古いパスのほうは使わないようにしてほしい
  例：/user_profile/xxx -> /user/profile/xxx

OpenAPIで使うな危険を示す方法

• deprecated=true に設定する（OpenAPI Specification）

ポイント

• 要らなくなったソースコードをごそっと削除するのとは違い、現在使われているAPIの場合、
  丸ごと定義を削除してしまうと「あれ？あのIF仕様どこいった？？」と思われてしまう
• しばらくの期間deprecatedの状態で置いておき、全体への周知が終わってから削除するべき