swagger-phpのスキーマ定義はannotationよりもAttributeの方が断然楽でした - Qiita
はじめに 弊社のプロダクトではOpenApIを活用して、実装コード中にスキーマ定義を記入し、APIドキュメントを生成しています。これまではAnnotation機能を利用していましたが、Attributeを利用した記述の方が書きやすかったため、それについてまとめてみました。 先に結論 Attributeを利用することでIDEのコード補完が効く Annotation特有のインデント崩れの心配がない 書き方の違いを比較してみる AnnotationとAttributesでどのように書き方が異なるのか比較できるように両方のパターンを用意しました。 Annotationで書くパターン Controller オフィシャルドキュメントより転載 <?php use OpenApi\Annotations as OA; /** * @OA\Info( * title="My First API", * ve
ZOZO Advent Calendar 2021 12日目の記事です。 Swagger UIを利用する際、右下に以下のようなバッジが表示されます。 VAILIDで表示されている場合は良いですが、外部のアクセスを遮断した状態でSwagger UIをホスティングする際はErrorが常に表示され続けます。Errorが表示されても特に支障はないのですがSwagger UIを見る人に誤解を招くので削除したいです。 小さいTipsになりますが、右下のVAILIDバッジを非表示にする方法を紹介します。 消し方 validatorUrlの設定を変更すると削除できます。 Swagger UIで変更可能な設定は以下にまとまっています。 swagger.io validatorUrlはデフォルトだとswagger.ioのonline validatorに対してvalidationを行います。なので外部のアクセ
はじめに APIを呼び出す機能をテストする際に、とりあえずモックサーバーを立てたい。 そんなときに便利なのが、SwaggerのNode.js 製のモジュールであるswagger-nodeです。 SwaggerでAPIを定義しておくだけで、モックサーバーを起動できます。 便利なのは、自前でテストデータを用意しなくても、データ型(string, number, boolean, array, object etc)に応じた適当な値をレスポンスしてくれる点です。 Swaggerの概要やswagger-nodeの使い方はこちらで紹介されているため、詳細は割愛します。 Swaggerとswagger-node この記事では、Node.jsのインストールが面倒なのと、環境を汚さずに使いたいということで、 swagger-nodeとDockerを組み合わせてモックサーバーを構築する方法を説明します。 前
はじめに しばらく使っていたSpringFoxでアプリケーションが実行できなくなる問題が発生していたので、Springdocへ乗り換え。ついでにOpenAPI2.0->OpenAPI3.0へ移行したのでまとめる。 概要 Springdocを使ってSwagger.yamlを生成。これを経由してSwaggerCodegenでマークダウン形式のAPIドキュメントを作成する。APIクライアントも作成されると思うが、今回はドキュメントのみチェック。 やったこと アプリケーションについて @OpenAPIDefinition( info = @Info( title = "サンプルAPIのタイトルです", version = "1.0", description = "サンプルAPIの説明です", license = @License(name = "ライセンス名", url = "https://q
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Swagger UIのVALIDバッジを非表示にする方法 - jongzの日記
swagger-nodeとDockerで簡単にモックサーバーを構築する - Qiita
Swaggerを使ってOpenAPI3.0のAPIドキュメントを作成する - Qiita