タグ付けされた質問 「swagger」

C＃ASP.NET WebAPIアプリケーションを使用しており、APIドキュメントはSwashbuckleを使用して自動的に生成されます。ドキュメントから特定のメソッドを省略できるようにしたいのですが、SwaggerにSwagger UI出力に含めないように指示する方法を理解できていないようです。 これはモデルまたはスキーマフィルターの追加に関係しているように感じますが、何をすべきかが明確ではなく、ドキュメントはメソッドの出力を変更する方法の例を提供するだけで、出力から完全に削除することはないようです。 前もって感謝します。

135 c#  asp.net  .net  swagger 

最近、SpringMvcとswagger -ui（v2）を使用してRESTfulAPIを作成しました。Postmanのインポート機能に気づきました。 だから私の質問は、Postmanが必要とするファイルをどのように作成するかです。 私はSwaggerに精通していません。

114 swagger  postman 

認証/セキュリティスキームでは、ヘッダーを次のように設定する必要があることを伝えようとしています。 Authorization: Bearer <token> これは私がswaggerドキュメントに基づいているものです： securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []

112 swagger  swagger-2.0  swagger-editor 

私のプロジェクトにはSpringSecurityがあります。主な問題：http：// localhost：8080 / api / v2 / api-docsでSwaggerURLにアクセスできません。承認ヘッダーがないか無効です。 ブラウザウィンドウのスクリーンショット 私のpom.xmlには次のエントリがあります <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> SwaggerConfig： @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2).select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { ApiInfo apiInfo = new ApiInfo("My REST …

97 spring-mvc  swagger  swagger-ui  swagger-2.0  springfox 

PHPで記述された一部のRESTAPIについて、Swaggerドキュメントを作成するように依頼されましたが、既存のAPIに注釈を追加してそのようなドキュメントを作成する簡単な方法がわからなかったため、このエディターを使用して今のところいくつかを生成しました。 そのエディターを使用して作成されたJSONファイルとYAMLファイルを保存しました。次に、最終的なインタラクティブなSwaggerドキュメントを作成する必要があります（このステートメントは単純で曖昧に聞こえるかもしれません）。 誰かがSwaggerJSON仕様ファイルを実際のSwaggerドキュメントに変換する方法を教えてもらえますか？ 私はWindowsプラットフォームを使用しており、Ant / Mavenについて何も知りません。

88 yaml  swagger  swagger-php 

私は単純なSpringで書かれたReSTFulAPIを持っています（Spring Bootも、派手なものもありません！）。これにSwaggerを実装する必要があります。これまでのところ、インターネット上のすべてのページは、私が移植性をまったく見つけられなかった混乱した構成と肥大化したコードに夢中になっているだけです。 これを達成するのに役立つサンプルプロジェクト（または一連の詳細な手順）を持っている人はいますか？特に、swagger-springmvcを使用した優れたサンプルを探しています。私はそれが「サンプル」を持っていることを知っています、しかしせいぜい、難解なコードは落胆しています。 「Swaggerが単に最高である理由」を探しているのではないことを明確にする必要があります。Spring Bootなどを使用していません（現在のタスクでは使用しません）。

85 spring  spring-mvc  swagger 

のようなパラメータがあるとしましょうlimit。これはあちこちで使用されており、更新する必要がある場合はどこでも変更する必要があるのは面倒です。 parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 $ refを使用してこれを他の場所で定義し、再利用可能にすることはできますか？誰かが機能を変更または改善したいと示唆しているこのチケットに出くわしましたが、それが今日すでに存在するかどうかわかりませんか？

84 swagger  swagger-2.0  openapi 

私の「簡略化された」APIでは、すべての応答は基本の「応答」クラスから派生（継承）されます。応答クラスはさ構成されるメタデータで満たされたヘッダ、ユーザが要求しているコアデータを含む体。応答（JSON）は、すべてのメタデータが最初の「レイヤー」にあり、本体が「本体」と呼ばれる単一の属性になるようにレイアウトされています。 response |--metadata attribute 1 (string/int/object) |--metadata attribute 2 (string/int/object) |--body (object) |--body attribute 1 (string/int/object) |--body attribute 2 (string/int/object) この関係を次のJSONを使用してSwaggerで定義しようとしました。 { ... "definitions": { "response": { "allOf": [ { "$ref": "#/definitions/response_header" }, { "properties": { "body": { "description": "The body of the response (not metadata)", "schema": { "$ref": "#/definitions/response_body" …

82 swagger 

過去2年間、SpringfoxでSpring Bootアプリケーションに取り組みました。Springfoxは、REST APIのドキュメントとテストUIを生成します。これは最高でした。 しかし実際には、Springfoxプロジェクトは死んでおり、最新のSpringをサポートしていません。3つの質問があります Swagger UIを直接生成する他の方法はありますか？他のライブラリ/プロジェクトはありますか？ Swagger uiをSpring Bootプロジェクトにどのように実装しますか？ おそらく時代遅れかもしれませんが、Spring BootのSwaggerスタッフに代わるはるかに優れた方法はありますか？ 何カ月も頻繁に使用し、テストした後の更新 SpringDoc OpenApi 私はそれがSpringfoxの代替ではない、と言うでしょう、それははるかに良いものです！安定しており、使いやすく、最新です！ 私はこれを100％お勧めできます！すべてのプロジェクトをSpringDoc OpenApiに移行します。

11 spring-boot  swagger  swagger-ui  springfox 

.Net core 3.0でWeb APIをいくつか開発していて、それをSwashBuckle.Swaggerと統合したいと考えています。正常に機能していますが、JWT認証を追加すると、期待どおりに機能しません。そのために、以下のコードを追加しました。 services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "My Web API", Version = "v1" }); c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme { Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"", Name = "Authorization", In = ParameterLocation.Header, Type = SecuritySchemeType.ApiKey }); }); AddSecurityDefinition関数を追加すると、[承認]ボタンが表示され、クリックすると、次のフォームが表示されます。 次に、と入力しますBearer …

10 swagger  asp.net-core-webapi  swashbuckle  .net-core-3.0 

プロジェクトにSwagger UIを統合しています。リクエストを行うにはトークンを渡す必要があります。 const mytoken = "heareismytoken"; const ui = SwaggerUIBundle({ url: "/swagger/v2/swagger.json", dom_id: '#swagger-ui', deepLinking: true, requestInterceptor: function (req) { var key = mytoken; if (key && key.trim() !== "") { req.headers.Authorization = 'Bearer ' + key; console.log('Authorized from authKey'); } }, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ SwaggerUIBundle.plugins.DownloadUrl …

8 javascript  swagger  swagger-ui