まず、パッケージをインストールnuget
Swashbuckle.AspNetCore.Swagger
Swashbuckle.AspNetCore.SwaggerGen
Swashbuckle.AspNetCore.SwaggerUI
1. configureServicesで闊歩登録コードを追加します。
1 公共 ボイドConfigureServices(IServiceCollectionサービス) 2 { 3 services.AddMvc()SetCompatibilityVersion(CompatibilityVersion.Version_2_2)。 4 5 services.AddSwaggerGen(C => 6 { 7 VAR XMLFILE = $ " {Assembly.GetExecutingAssembly()関連項目GetName()名前} .XML。" ; 8 VAR xmlPath1 = System.IO.Path.Combine(AppContext.BaseDirectory、 $ " {XMLFILE} " ); 9 10 VAR xmlModelPath1 = System.IO.Path.Combine(AppContext.BaseDirectory、$" ClassLibrary1.xml " ) 。11 c.IncludeXmlComments(xmlPath1); 12であり ; c.IncludeXmlComments(xmlModelPath1) 13である 14 c.SwaggerDoc(" V1 "、新たな新規Swashbuckle.AspNetCore.Swagger.Info 15 { 16 タイトル= " テスト"、// 項目に従って変更 17 バージョン= 「V1 」、 18 名刺= 新新Swashbuckle.AspNetCore.Swagger.Contact 19 { 20 名= " テスト" 、 21 メール= " [email protected] " 、 22 のURL = " https://www.test.com " 23 }、 24 ライセンス= 新しいライセンス 25 { 26 名= " 内部授权" 、 27 のURL =" https://www.test.com " 28 } 29 }); 30 }); 31 }
2.使用闊歩は、ミドルウェアを設定します
1つの 公共 ボイド設定(APP IApplicationBuilder、IHostingEnvironment ENV) 2 { 3。 IF (env.IsDevelopment()) 4。 { 5。 app.UseDeveloperExceptionPage(); 6 } 7。 8。 app.UseMvc(); 9 // 生成闊歩ミドルウェアサービスを有効にしますJSONエンドポイントとして 10 )app.UseSwagger(; 11 // ミドルウェアサービス闊歩-UIを有効に指定闊歩JSONエンドポイント 12は app.UseSwaggerUI(C => // 参照Swashbuckle.AspNetCore.SwaggerUI 13は { 14 c.SwaggerEndpoint(" ../swagger/v1/swagger.json "、" O2O注文API "); // APIはアプリケーションと一致するように変更されたSMS 15 }); 16 }
WebプロジェクトとプロジェクトVModelとしてXMLドキュメントを生成
ProducesResponseTypeは、界面特性に戻り値を記述する情報を用います。
•プロジェクトは、入力を開始ます。http:// localhostを:54022 /闊歩 / index.htmlをします
あなたのIPアドレスとポートに項目に対応するIPポート
ただパラメータと戻り値の情報を表示するインターフェイスを設定し、ポストを開きます