openapi-generator におけるRestful

忙しい人のための結論

• tag付けは必須かもしれない
• tagとpathはpathParamを除いたとき大文字小文字は無視して一致しなければならない
• pathParamは一つのみしか許容されない
• POSTはpathParamを含めることはできない
• PUT, PATCH, DELETEはpathParamが必要

目次

1. [openapi-generator におけるRestful](# openapi-generator におけるRestful)
2. [openapi-generator におけるtagとoperation](# openapi-generator におけるtagとoperation)

openapi-generator におけるRestful

GET

以下の条件に当てはまるとき

• pathに対してtagがそれと一致する。大文字小文字は考えない (e.g. pathが/usersでusersのtagが付与されているoperation
• pathにただ一つのpathParamがあり、pathParamを除くときtagと一致する。大文字小文字は考えない (e.g. pathが/users/{userID}でtagがusers

POST

• pathに対してtagがそれと一致する。大文字小文字は考えない (e.g. pathが/usersでusersのtagが付与されているoperation

PUT, PATCH

• pathにただ一つのpathParamがあり、pathParamを除くときtagと一致する。大文字小文字は考えない (e.g. pathが/usersでusersのtagが付与されているoperation

DELETE

• pathにただ一つのpathParamがあり、pathParamを除くときtagと一致する。大文字小文字は考えない (e.g. pathが/usersでusersのtagが付与されているoperation

openapi-generator におけるtagとoperation

opeanapiにおいてoperationに対し複数のtagをつけることは許容されている気がします

openapi-generatorにおいてはtagを複数つけるとtagをbaseNameとするoperationが生成されます

つまりoperationにおいてはtagを複数つけるとその分operationが生成されます

tagがない場合では一つのoperationがdefaultのtagで生成されます

スタブはこれを無視していることが多いためtagを複数つけると同じhandlerが複数生成されたりする気がします