7.Asp.net添加Swagger

一赫技术 2024-03-13 22:18:35
摘要

在Asp.net 6新建的Api应用下添加Swagger,可以通过一些简单的步骤实现。首先,您需要安装Swagger工具,并将其集成到您的应用程序中。这可以通过将Swagger文件添加到您的应用程序文件夹中,或者通过使用Swagger.json文件来完成。

接下来,您需要创建Swagger文档。Swagger文档是一个可扩展的格式,可以描述您的API的所有端点和参数。Swagger文档还包括使用说明和示例,以帮助开发人员更好地理解和使用您的API。

一旦您创建了Swagger文档,您可以将其共享给开发人员。您可以将Swagger文档嵌入到您的应用程序中,或者将其发布到您的网站上,以便开发人员可以在任何地方访问它们。您还可以使用Swagger UI来展示Swagger文档,以便开发人员可以直接在浏览器中查看和测试您的API。

Swagger是一种非常有用的工具,可以帮助开发人员更好地理解和使用您的API。通过在Asp.net 6新建的Api应用下添加Swagger,您可以轻松地创建、共享和使用API文档,以提高开发人员之间的合作效率。

Swagger 安装

右键单击应用程序项目,选择“管理NuGet程序包”来打开NuGet程序包管理器, 安装 Swashbuckle.AspNetCore 依赖。

双击项目文件,在 PropertyGroup 中添加以下

<GenerateDocumentationFile>true</GenerateDocumentationFile>

修改Program文件

//配制Swaggerbuilder.Services.AddSwaggerGen(x =>{ x.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Version= "v1", Title="API", Description="默认API" }); var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; //开启控制器注释参数,第2个参数显示声明为 true x.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);});//中载Swagger UIapp.UseSwagger();app.UseSwaggerUI(c =>{ c.SwaggerEndpoint("/swagger/v1/swagger.json", "v1"); c.RoutePrefix = string.Empty; c.DocExpansion(Swashbuckle.AspNetCore.SwaggerUI.DocExpansion.None); c.DefaultModelsExpandDepth(-1);});

运行应用,打开index.html

0 阅读:7

一赫技术

简介:感谢大家的关注