diff --git a/IGeekFan.AspNetCore.Knife4jUI.sln b/IGeekFan.AspNetCore.Knife4jUI.sln index 5157184..fa97e6b 100644 --- a/IGeekFan.AspNetCore.Knife4jUI.sln +++ b/IGeekFan.AspNetCore.Knife4jUI.sln @@ -26,7 +26,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "WebSites", "WebSites", "{86 EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OAuth2Integration", "test\WebSites\OAuth2Integration\OAuth2Integration.csproj", "{9E8D8F42-33F0-4F2D-9B56-1AB1B33DE1FA}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NSwag.Swagger.Knife4jUI", "NSwag.Swagger.Knife4jUI\NSwag.Swagger.Knife4jUI.csproj", "{32CF97CB-E877-4EB6-A9EB-03A566FFF2B0}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "NSwag.Swagger.Knife4jUI", "test\WebSites\NSwag.Swagger.Knife4jUI\NSwag.Swagger.Knife4jUI.csproj", "{42B4C1C3-AE38-47C7-AAAA-FE0FDA7DADEB}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -54,10 +54,10 @@ Global {9E8D8F42-33F0-4F2D-9B56-1AB1B33DE1FA}.Debug|Any CPU.Build.0 = Debug|Any CPU {9E8D8F42-33F0-4F2D-9B56-1AB1B33DE1FA}.Release|Any CPU.ActiveCfg = Release|Any CPU {9E8D8F42-33F0-4F2D-9B56-1AB1B33DE1FA}.Release|Any CPU.Build.0 = Release|Any CPU - {32CF97CB-E877-4EB6-A9EB-03A566FFF2B0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {32CF97CB-E877-4EB6-A9EB-03A566FFF2B0}.Debug|Any CPU.Build.0 = Debug|Any CPU - {32CF97CB-E877-4EB6-A9EB-03A566FFF2B0}.Release|Any CPU.ActiveCfg = Release|Any CPU - {32CF97CB-E877-4EB6-A9EB-03A566FFF2B0}.Release|Any CPU.Build.0 = Release|Any CPU + {42B4C1C3-AE38-47C7-AAAA-FE0FDA7DADEB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {42B4C1C3-AE38-47C7-AAAA-FE0FDA7DADEB}.Debug|Any CPU.Build.0 = Debug|Any CPU + {42B4C1C3-AE38-47C7-AAAA-FE0FDA7DADEB}.Release|Any CPU.ActiveCfg = Release|Any CPU + {42B4C1C3-AE38-47C7-AAAA-FE0FDA7DADEB}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -69,7 +69,7 @@ Global {6C784918-BE29-4FEF-8AC3-9D34A38DE822} = {929BB2D7-C678-4BE8-8AA9-F271A2AE4545} {86851B6C-3504-4879-8464-1DB422D46BA0} = {75C51574-4CBD-403B-8182-8BF2A6DCFD43} {9E8D8F42-33F0-4F2D-9B56-1AB1B33DE1FA} = {86851B6C-3504-4879-8464-1DB422D46BA0} - {32CF97CB-E877-4EB6-A9EB-03A566FFF2B0} = {C146A419-15E0-4475-9623-706C5E2DCE0B} + {42B4C1C3-AE38-47C7-AAAA-FE0FDA7DADEB} = {86851B6C-3504-4879-8464-1DB422D46BA0} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {9D77CCB4-F597-421B-9EF9-52D4B0AC382D} diff --git a/README.md b/README.md index b2b3e45..6ca95c8 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,24 @@ ### 🚀安装包 +以下为使用Swashbuckle.AspNetCore.Swagger底层组件 + 1.Install the standard Nuget package into your ASP.NET Core application. ``` -Package Manager : Install-Package IGeekFan.AspNetCore.Knife4jUI -CLI : dotnet add package IGeekFan.AspNetCore.Knife4jUI +Package Manager : + +Install-Package Swashbuckle.AspNetCore.Swagger +Install-Package Swashbuckle.AspNetCore.SwaggerGen +Install-Package IGeekFan.AspNetCore.Knife4jUI + +OR + +CLI : + +dotnet add package Swashbuckle.AspNetCore.Swagger +dotnet add package Swashbuckle.AspNetCore.SwaggerGen +dotnet add package IGeekFan.AspNetCore.Knife4jUI ``` 2.In the ConfigureServices method of Startup.cs, register the Swagger generator, defining one or more Swagger documents. @@ -92,6 +105,32 @@ c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, "SwaggerDemo.xml"),t +### NSwag.AspNetCore +(请参考目录test/WebSites/NSwag.Swagger.Knife4jUI) + +``` +public void ConfigureServices(IServiceCollection services) + { + // 其它Service + services.AddOpenApiDocument(); + } +``` + +``` +public void Configure(IApplicationBuilder app, IWebHostEnvironment env) +{ + // 其它 Use + app.UseOpenApi(); + app.UseKnife4UI(c => + { + c.RoutePrefix = ""; + c.SwaggerEndpoint("/swagger/v1/swagger.json"); + }); +} +``` + +即可使用 Knife4jUI + ### 🔎 效果图 运行项目,打开 https://localhost:5001/index.html#/home diff --git a/src/IGeekFan.AspNetCore.Knife4jUI/IGeekFan.AspNetCore.Knife4jUI.csproj b/src/IGeekFan.AspNetCore.Knife4jUI/IGeekFan.AspNetCore.Knife4jUI.csproj index f3b82c3..177e6a5 100644 --- a/src/IGeekFan.AspNetCore.Knife4jUI/IGeekFan.AspNetCore.Knife4jUI.csproj +++ b/src/IGeekFan.AspNetCore.Knife4jUI/IGeekFan.AspNetCore.Knife4jUI.csproj @@ -17,8 +17,8 @@ true Apache License 2.0 - 0.0.7.0 - 0.0.7.0 + 0.0.8.0 + 0.0.8.0 diff --git a/NSwag.Swagger.Knife4jUI/Controllers/WeatherForecastController.cs b/test/WebSites/NSwag.Swagger.Knife4jUI/Controllers/WeatherForecastController.cs similarity index 100% rename from NSwag.Swagger.Knife4jUI/Controllers/WeatherForecastController.cs rename to test/WebSites/NSwag.Swagger.Knife4jUI/Controllers/WeatherForecastController.cs diff --git a/NSwag.Swagger.Knife4jUI/NSwag.Swagger.Knife4jUI.csproj b/test/WebSites/NSwag.Swagger.Knife4jUI/NSwag.Swagger.Knife4jUI.csproj similarity index 56% rename from NSwag.Swagger.Knife4jUI/NSwag.Swagger.Knife4jUI.csproj rename to test/WebSites/NSwag.Swagger.Knife4jUI/NSwag.Swagger.Knife4jUI.csproj index c147a16..eb543ae 100644 --- a/NSwag.Swagger.Knife4jUI/NSwag.Swagger.Knife4jUI.csproj +++ b/test/WebSites/NSwag.Swagger.Knife4jUI/NSwag.Swagger.Knife4jUI.csproj @@ -1,7 +1,7 @@ - net5.0 + netcoreapp3.1 @@ -9,7 +9,7 @@ - + diff --git a/NSwag.Swagger.Knife4jUI/Program.cs b/test/WebSites/NSwag.Swagger.Knife4jUI/Program.cs similarity index 100% rename from NSwag.Swagger.Knife4jUI/Program.cs rename to test/WebSites/NSwag.Swagger.Knife4jUI/Program.cs diff --git a/NSwag.Swagger.Knife4jUI/Properties/launchSettings.json b/test/WebSites/NSwag.Swagger.Knife4jUI/Properties/launchSettings.json similarity index 100% rename from NSwag.Swagger.Knife4jUI/Properties/launchSettings.json rename to test/WebSites/NSwag.Swagger.Knife4jUI/Properties/launchSettings.json diff --git a/NSwag.Swagger.Knife4jUI/Startup.cs b/test/WebSites/NSwag.Swagger.Knife4jUI/Startup.cs similarity index 100% rename from NSwag.Swagger.Knife4jUI/Startup.cs rename to test/WebSites/NSwag.Swagger.Knife4jUI/Startup.cs diff --git a/NSwag.Swagger.Knife4jUI/WeatherForecast.cs b/test/WebSites/NSwag.Swagger.Knife4jUI/WeatherForecast.cs similarity index 100% rename from NSwag.Swagger.Knife4jUI/WeatherForecast.cs rename to test/WebSites/NSwag.Swagger.Knife4jUI/WeatherForecast.cs diff --git a/NSwag.Swagger.Knife4jUI/appsettings.Development.json b/test/WebSites/NSwag.Swagger.Knife4jUI/appsettings.Development.json similarity index 100% rename from NSwag.Swagger.Knife4jUI/appsettings.Development.json rename to test/WebSites/NSwag.Swagger.Knife4jUI/appsettings.Development.json diff --git a/NSwag.Swagger.Knife4jUI/appsettings.json b/test/WebSites/NSwag.Swagger.Knife4jUI/appsettings.json similarity index 100% rename from NSwag.Swagger.Knife4jUI/appsettings.json rename to test/WebSites/NSwag.Swagger.Knife4jUI/appsettings.json