はじめに 開いていただきありがとうございます。 OpenAPIを書く際はこれまでブラウザ上の「Swagger Editor」を使用していました。 プラグインを入れることでVScodeでも書けることがわかった(おそらく今後は全部VScodeで書くことになるんだろうな・・・)ので、その際に使用したプラグインをまとめてみようと思います。 プラグイン Swagger Viewer viewerを開くには以下の方法で行います。 コマンドパレットから「Preview Swagger」を選択 shift + option + p 以下のようにSwagger Editorと同じ画面で確認することができます。 また、編集はリアルタイムで更新されます。 openapi-lint openAPIのドキュメントを検証や静的解析を行ってくれる拡張機能です。 OpenAPI(Swagger) Editor エクスプロ
はじめに Laravelのl5-swaggerでAPIドキュメント兼API動作確認を行う際に、multipart/form-data形式でのswaggerを作成する方法。 TL; DR; RequestBody の MediaType で mediaType="multipart/form-data"を指定する。 Schema の Property で項目を列挙する 記載方法 /** * * @OA\Post( * path="/sample", * operationId="multipart sample", * @OA\RequestBody( * @OA\MediaType( * mediaType="multipart/form-data",// <-ここでマルチパートを指定する * @OA\Schema( * type="object",// <-object形式にして複数の値
＜?php namespace App\Http\Controllers; /** * @OA\Info( * version="1.0.0", * title="L5-Swaggerサンプル", * description="サンプル", * ) */ class HelloController extends Controller { /** * @OA\Get( * path="/hello", * operationId="hello", * tags={"タグ"}, * summary="ハロー", * description="こんにちは", * @OA\Response( * response=200, * description="成功", * @OA\JsonContent( * type="object", * @OA\Property( * property="mes
概要 最近は API Blueprint で仕様書を書くことが多かったのですが、Swagger が世界標準になるかもしれない、ということもあり、開発の効率化を進めるためにも概要をまとめてみようと思った次第です。 Swaggerとは Swagger は RESTful APIを構築するためのオープンソースのフレームワークのことです。「Open API Initiative」という団体がRESTful APIのインターフェイスの記述をするための標準フォーマットを推進していて、その標準フォーマットがSwaggerです。Swaggerには多くの便利なツールが提供されていることもあり、多くのメリットを享受できそうです。 Swagger Spec を書いておけば自動的にドキュメント生成までしてくれ、それだけではなく、ドキュメントから実際のリクエストを投げられる優れものです。 Swaggerのツール群
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
