OpenApi

Generators List · OpenAPI Generator

usage

generators

client , backend, documentを生成できる

Gin

code:generate

openapi-generator generate \

-i openapi.yaml \

-g go-gin-server \

-o out

Axios

code:sh

openapi-generator-cli generate \

-i openapi.yaml \

-g typescript-axios \

-o api-clinet

リファレンス

Swagger

---

OpenAPI定義ファイルツール

Stoplight studio

直感的に修正できる

モデル

model.yamlは細かく定義したほうが良い？

小のモデルを定義せず、親モデルに含めると、出力の際、親モデル名が小モデルにprefixされる。

出力

references設定でBundled (Recommended)ではなくDereferencedにしないと、OpenAPI Generatorで上手く出力できなかった。

モデルにV2,V3などがついてしまう。

Githubとの連携

一度連携したあと、組織アカウントの参照権を追加する場合以下の手順が必要だった。

一度連携解除→github oauthアプリでstoplight削除

------

モック

Prism

api mock

yamlのデータモデルを元にモックサーバーが起動

code:install.sh

yarn global add @stoplight/prism-cli

# -d dynamic mock

# モデル定義に応じてランダムなfakeデータを返す

prism mock -d openapi.v1.yaml

OpenAPIツール

ここでも定義を作成できる

OpenAPI関連ツール

Apicurio