問題タブ [swagger-3.0]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
swagger-3.0 - 汎用 API 応答の Swagger 定義を作成できません
私のサーバーアプリケーションjson
は、次の形式で応答を送信します
additional-info
成功メッセージ (「操作が成功しました」など)、エラー メッセージ (「操作が失敗しました」など)、または文字列形式のオブジェクト ( {user-name: manu}
.
swagger
上記のオブジェクトの定義を次のように作成しました。
次に、次のようにAPIで上記の定義を使用しようとしています
私の問題は、現時点では、ServerFailureResponse
または何が含まれるServerSuccessResponse
かわかりません. additional-info
に含まれるものも明確になるように API 定義を再設計したいと考えていますadditional-info
。私ができる方法はありますか?additional-info
コードでは、まだラッパーとして使用したいです。私が欲しいのは、各応答Swagger
の内容が明確であることだけです。additional-info
php - swagger-php を使用してネストされたプロパティをフォームデータとしてシリアル化する
これは、エンコーディング オブジェクトの例が OpenApi で行われる方法です https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md
私は同じことを達成しようとしていますが、swagger-php を使用しています。私が知らないのは、デフォルトで次のようにエンコードされているため、プロパティを次のようencodings
に@OA\MediaType
エンコードするために渡す方法ですtest
multipart/form-data
application/json
元:
ここにいくつかの例があります:
https://github.com/zircote/swagger-php/tree/master/Examples
しかし、エンコーディングに関する例は見つかりませんでした
ここでフィールドが定義されてい ます https://github.com/zircote/swagger-php/blob/master/src/Annotations/MediaType.php
やってみencoding={"recommended"={"contentType"="multipart/form-data"}}
たけど駄目。
swagger-ui - 基本認証資格情報 Swagger 3 に異なるラベルを使用する方法
api_xxx
現在、私の API はの代わりにusername
とのapi_xxy
代わりにBasic 認証を使用しpassword
ていますが、そのような状況のための特定のスキーマはありますか?
すべてがまったく同じように機能します。ユーザー名とパスワードの UI のラベルのみを変更したいと思います。
次の機能は、次のように説明されています。