openapi

1熱

1答えて

単一のopenapi（v3）仕様で非認証およびOauth2エンドポイントの両方を指定する方法はありますか？

私は、既存のパブリックAPIのopenapi仕様（つまり、 "swagger v3"）を作成しています。このAPIには、承認されていないoauth2認証エンドポイントがあります。私はGithubの仕様を参照し、StackoverflowとGoogleを使用して検索しました。私は一回使用プロトコルの例を見出しましたが、2つのプロトコルがある場合はそうではありませんでした。 openapi v3を使

1熱

1答えて

Open API継承したサンプルデータ

私は、ビルドしているサービスのAPIを定義するためにOpenAPI 3.0を使用しています。私は、他のコンポーネントの中でスキーマコンポーネントを再利用することに問題があります。たとえば、ノートを作成した人のProfileオブジェクトを含むNoteオブジェクトがあります。これは、$refキーワードを使用してProfileオブジェクトを参照することにより、正常に動作します。この問題は、プロファイルの

0熱

1答えて

OpenAPI複数のタイプの配列内

OpenAPI 3を使用して再利用可能なスキーマコンポーネントを定義する際に、複数のタイプを含む配列を使用できない場合があります。各アイテムタイプは同じ親クラスから継承されますが、特定の子プロパティを持ちます。これはSwaggerHub上のmodelビューで問題なく動作しているようですが、サンプルビューではデータが正しく表示されません。 TLDR; OpenAPI 3で異なるオブジェクトタイプを含

1熱

2答えて

openapi v3では、エンドポイントの認証を指定する方法は任意です。

私は、認証がオプションのさまざまなエンドポイントを含む既存のAPIを文書化しようとしています。つまり、ユーザーが権限を持っている場合は、権限のないユーザーよりも多くのデータが返されます。 OAspec v3で明示的にそれを見つけることができませんでした。この状況を定義するためのコーディングのトリックはありますか？私の現在の回避策は、承認をコードすることですが、エンドポイントの記述では承認はオプシ

0熱

1答えて

vertexプロジェクトのOpenAPI仕様を生成する

私のVertexプロジェクトにOpenAPI仕様を生成したい。次のようにだから私はちょうど私のJSONオブジェクトを返す簡単なVERTXサーバーを持っている： package server; import io.vertx.core.AbstractVerticle; import io.vertx.core.http.HttpServer; import io.vertx.core.ht

0熱

2答えて

名前のないオブジェクトの配列を使ってswagger/open APIレスポンスを作成する

httpリクエストからの応答は、次の形式で取得されます。名前のない配列とオブジェクトの配列です。私はこのケースのための適切なSwagger（Open API）仕様を理解できません。 [ [ { "prop1": "hello", "prop2": "hello again" }, { "prop1": "bye",

0熱

1答えて

どのようにOpenAPIをaws_api_gateway_rest_apiに使用するのですか

OpenAPIは標準のように見えますし、terraformリソースよりも煩雑ではありません。私テラフォームが取るかもしれないものに変換されたJSONをしましたが、私はエラーを取得： module.aws_api_gateway.aws_api_gateway_rest_api.CICDAPI: body must be a single value, not a list ベローが私のコードで

0熱

1答えて

OpenAPI定義をインポートする際に、「スキーマ」が「応答」オブジェクトから消えてしまうのはなぜですか？

次のOpenAPI定義をAzure API Managementに正常にインポートできます。私はOpenAPIの定義をエクスポートするときしかし、「スキーマ」の名前は、「応答」オブジェクトから削除されました。その結果、私のポータルの開発者は、この操作のスキーマや例は表示されません。 APIの定義は有効で、the official editorに追加すると正しく機能します。スキーマが削除されない

1熱

1答えて

頻繁に使用される説明オブジェクトを$ Refすることができるコンポーネントオブジェクトを使用してトリックがありますか？

私は、自分自身が何度も繰り返しrequestbody> contentの中で説明を繰り返すことに気付きました。 OpenAPI v3仕様のDRYテクニックを探しました。ここでは、物事を単純化するために$ Refを使用するかもしれません。何も私に飛び出したことはありません。だから私は彼らが道を知っているかどうかここで専門家に尋ねると思った。

1熱

1答えて

openapi v3レスポンスボディの複数行の例

要求の本文に複数行のサンプルを記述する方法はありますか？可能であれば、Swagger-UIで実行しているとき、OpenApiドキュメントを次のように表示したいと思います。あなたはあなたの言語についてはあまり言わない