【免费】aspnetcore集成swagger_查看aspnetcore版本资源-CSDN文库

共52个文件

json：12个

dll：8个

cs：7个

需积分: 0 156 浏览量 2023-08-28 21:59:21 上传评论收藏 1.29MB ZIP 举报

ASP.NET Core 集成 Swagger 是一种常见的API文档管理和测试工具解决方案。Swagger，也称为OpenAPI Specification（OAS），是一个用于描述RESTful API的规范，它允许开发者通过JSON格式定义API接口，使得服务消费者可以更好地理解和使用API。ASP.NET Core是微软推出的一个开源、跨平台的web框架，支持构建高性能的现代化网络应用。在ASP.NET Core中集成Swagger，主要目的是为开发者提供一个友好的图形化界面来查看和测试API。以下是一些关键知识点： 1. **Swashbuckle库**：Swashbuckle是ASP.NET Core社区开发的一个NuGet包，用于将Swagger集成到ASP.NET Core应用程序中。它能够自动发现和生成API的Swagger定义，并基于此生成用户友好的Swagger UI。 2. **安装Swashbuckle**：你需要在你的项目中通过NuGet包管理器或dotnet CLI安装`Swashbuckle.AspNetCore`包。 3. **配置Swagger**：在`Startup.cs`文件的`ConfigureServices`方法中，添加`AddSwaggerGen`服务，然后在`Configure`方法中使用`UseSwagger`和`UseSwaggerUI`中间件来启用Swagger UI。这样，Swagger将在运行时自动生成API文档。 ```csharp services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" }); }); app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); }); ``` 4. **注解和模型绑定**：Swagger会根据你的控制器和行动方法的参数、返回类型来生成API描述。使用`[Route]`、`[HttpGet]`等特性来标记HTTP操作，`[FromBody]`、`[FromQuery]`等特性指定参数来源。确保你的模型类有良好的注释，因为这些注释会被Swagger用来生成模型描述。 5. **自定义Swagger配置**：你还可以自定义Swagger的显示信息，比如添加描述、术语、联系人信息、许可证等。此外，可以通过`SwaggerGenOptions`的配置方法来进一步定制Swagger的行为，例如忽略特定的API、处理复杂类型等。 6. **API版本管理**：如果你的API支持多个版本，可以使用ASP.NET Core的版本控制特性，Swagger会自动处理不同版本的API展示。 7. **安全性设置**：Swagger还支持API密钥、OAuth2等安全设置，你可以通过配置Swagger UI来要求用户提供必要的认证信息。 8. **测试API**：Swagger UI提供了直接测试API的功能。用户可以直接在界面上输入参数，点击执行按钮来测试API，这对于开发和调试阶段非常有用。 9. **部署和访问**：部署应用后，通常可以在应用的URL后加上 `/swagger` 或 `/swagger/v1/swagger.json` 来访问Swagger UI和JSON定义。在给出的文件列表中，`global.json`可能包含项目的全局配置，`ljc_abc_abc.sln`是Visual Studio的解决方案文件，`.idea`目录可能是IntelliJ IDEA或其他基于JetBrains的IDE的工作区文件，而`ljc_abc_abc`可能是一个项目或目录名。不过，这些文件与Swagger的集成没有直接关系，它们更多的是开发环境和项目结构的组成部分。

资源推荐

资源详情

资源评论

收起资源包目录

ljc_abc_abc.zip （52个子文件）

.idea

.idea.ljc_abc_abc

.idea

projectSettingsUpdater.xml 184B

workspace.xml 1KB

.gitignore 288B

encodings.xml 169B

indexLayout.xml 198B

global.json 105B

ljc_abc_abc.sln 788B

ljc_abc_abc

obj

ljc_abc_abc.csproj.nuget.g.targets 546B

project.packagespec.json 1KB

ljc_abc_abc.csproj.nuget.g.props 2KB

project.assets.json 11KB

ljc_abc_abc.csproj.nuget.dgspec.json 2KB

staticwebassets.pack.sentinel 4B

rider.project.restore.info 20B

Debug

net6.0

ljc_abc_abc.assets.cache 2KB

ljc_abc_abc.genruntimeconfig.cache 41B

ljc_abc_abc.csproj.CopyComplete 0B

ljc_abc_abc.csproj.FileListAbsolute.txt 3KB

apphost 129KB

refint

ljc_abc_abc.dll 7KB

ljc_abc_abc.GeneratedMSBuildEditorConfig.editorconfig 836B

ljc_abc_abc.csproj.CoreCompileInputs.cache 41B

ljc_abc_abc.MvcApplicationPartsAssemblyInfo.cs 562B

ljc_abc_abc.AssemblyInfo.cs 937B

staticwebassets

staticwebassets.build.json 273B

ljc_abc_abc.GlobalUsings.g.cs 753B

ljc_abc_abc.MvcApplicationPartsAssemblyInfo.cache 0B

ljc_abc_abc.csproj.AssemblyReference.cache 136KB

.NETCoreApp,Version=v6.0.AssemblyAttributes.cs 189B

ljc_abc_abc.pdb 20KB

ref

ljc_abc_abc.dll 7KB

ljc_abc_abc.AssemblyInfoInputs.cache 41B

ljc_abc_abc.dll 10KB

project.nuget.cache 1KB

appsettings.Development.json 119B

ljc_abc_abc.csproj 337B

WeatherForecast.cs 247B

bin

Debug

net6.0

Microsoft.OpenApi.dll 170KB

appsettings.Development.json 119B

ljc_abc_abc.runtimeconfig.json 398B

Swashbuckle.AspNetCore.SwaggerUI.dll 3.55MB

ljc_abc_abc.deps.json 4KB

Swashbuckle.AspNetCore.SwaggerGen.dll 84KB

ljc_abc_abc.pdb 20KB

Swashbuckle.AspNetCore.Swagger.dll 15KB

appsettings.json 142B

ljc_abc_abc 129KB

ljc_abc_abc.dll 10KB

Properties

launchSettings.json 808B

Program.cs 531B

Controllers

WeatherForecastController.cs 943B

appsettings.json 142B

/Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/appsettings.Development.json /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/appsettings.json /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/ljc_abc_abc /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/ljc_abc_abc.deps.json /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/ljc_abc_abc.runtimeconfig.json /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/ljc_abc_abc.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/ljc_abc_abc.pdb /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/Microsoft.OpenApi.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/Swashbuckle.AspNetCore.Swagger.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/Swashbuckle.AspNetCore.SwaggerGen.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/bin/Debug/net6.0/Swashbuckle.AspNetCore.SwaggerUI.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.csproj.AssemblyReference.cache /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.GeneratedMSBuildEditorConfig.editorconfig /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.AssemblyInfoInputs.cache /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.AssemblyInfo.cs /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.csproj.CoreCompileInputs.cache /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.MvcApplicationPartsAssemblyInfo.cs /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.MvcApplicationPartsAssemblyInfo.cache /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/staticwebassets.build.json /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/staticwebassets.development.json /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/scopedcss/bundle/ljc_abc_abc.styles.css /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.csproj.CopyComplete /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/refint/ljc_abc_abc.dll /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.pdb /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ljc_abc_abc.genruntimeconfig.cache /Users/mac/Desktop/jetProject/sjxit-asq-backend-/webapi/ljc_abc_abc/ljc_abc_abc/obj/Debug/net6.0/ref/ljc_abc_abc.dll

评论收藏

内容反馈