laravel-openapiライブラリ コマンド集

概要

• laravel-openapiにて各種クラス作成時のphp artisan コマンドをまとめる。

コマンド集（簡易版）

ユースケース	コマンド	備考
OpenAPI 出力	$ php artisan openapi:generate コレクション名
リクエストボディークラス作成	$ php artiasn openapi:make-requestBody リクエストボディークラス名	ファイル名のRequestBody.phpは自動付与されない
レスポンスクラス作成	$ php artisan openapi:make-response レスポンスクラス名	ファイル名のResponse.phpは自動付与されない
パラメータークラス作成	$ php artisan openapi:make-parameters パラメータークラス名	ファイル名のParameters.phpは自動付与
スキーマクラス作成	$ php artisan openapi:make-schema スキーマクラス名	ファイル名のSchema.phpは自動付与
セキュリティースキーマクラス作成	$ php artisan openapi:make-security-scheme セキュリティースキーマクラス名	ファイル名のSecurityScheme.phpは自動付与

コマンド集

OpenAPIのドキュメントを出力したい

• コマンド

  $ php artisan openapi:generate コレクション名
  

• コマンド例

  $ php artisan openapi:generate default
  

• 出力先とファイル名

  ※ターミナルにJSONで出力される
  

• 備考

  • JSONのみ出力可能
  • yamlでの出力不可
  • 引数のコレクション名は省略可能、省略したときdefaultのコレクションが適用される。

リクエストボディークラスを作成したい

• コマンド

  $ php artiasn openapi:make-requestBody リクエストボディークラス名
  

• コマンド例

  $ php artiasn openapi:make-requestBody CreateUserRequestBody
  

• 出力先とファイル名

  app/OpenApi/RequestBodies/CreateUserRequestBody.php
  

• 備考

  • ファイル名末尾のRequestBody.phpは自動で付与されないので注意

レスポンスクラスを作成したい

• コマンド

  $ php artisan openapi:make-response レスポンスクラス名
  

• コマンド例

  $ php artisan openapi:make-response CreateUserResponse
  

• 出力先とファイル名

  app/OpenApi/Responses/CreateUserResponse.php
  

• 備考

  • ファイル名末尾のResponse.phpは自動で付与されないので注意

パラメータークラスを作成したい

• コマンド

  $ php artisan openapi:make-parameters パラメータークラス名
  

• コマンド例

  $ php artisan openapi:make-parameters CreateUser
  

• 出力先とファイル名

  app/OpenApi/Parameters/CreateUserParameters.php
  

• 備考

  • ファイル名末尾のParameters.phpは自動で付与される

スキーマクラスを作成したい

• コマンド

  $ php artisan openapi:make-schema スキーマクラス名
  

• コマンド例

  $ php artisan openapi:make-schema CreateUserResponse
  

• 出力先とファイル名

  app/OpenApi/Schemas/CreateUserResponseSchema.php
  

• 備考

  • ファイル名末尾のSchema.phpは自動で付与される

セキュリティースキーマクラスを作成したい

• コマンド

  $ php artisan openapi:make-security-scheme セキュリティースキーマクラス名
  

• コマンド例

  $ php artisan openapi:make-security-scheme App
  

• 出力先とファイル名

  app/OpenApi/SecuritySchemes/AppSecurityScheme.php
  

• 備考

  • ファイル名末尾のSecurityScheme.phpは自動で付与される