ASP.NETCore-传输端点架构Swagger文档。
创始人
2024-09-17 07:32:08
0

要在 ASP.NET Core 应用程序中传输端点架构 Swagger 文档,需要执行以下步骤:

1.添加 Swagger 包:使用 NuGet 包管理器或 Package Manager Console,将以下包添加到应用程序中。

Swashbuckle.AspNetCore

2.配置 Swagger:在应用程序的 Startup.cs 文件中,使用以下代码段配置 Swagger。

using Swashbuckle.AspNetCore.Swagger; using Swashbuckle.AspNetCore.SwaggerUI; ... public void ConfigureServices(IServiceCollection services) { ... services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" }); }); } ... public void Configure(IApplicationBuilder app, IHostingEnvironment env) { ... app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); }); }

这将向应用程序添加 Swagger UI 和 Swagger JSON 端点。

3.启用 XML 注释:从 Visual Studio 属性窗口中启用 XML 注释,这将允许 Swashbuckle 自动生成文档。

4.重建应用程序并启动:通过 Visual Studio 或命令行重建应用程序并启动它,在浏览器中访问 Swagger 的端点 URL,即可看到文档。

这是一个示例 Web API 控制器:

[Route("api/[controller]")] [ApiController] public class ValuesController : ControllerBase { // GET api/values [HttpGet] public ActionResult> Get() { return new string[] { "value1", "value2" }; }

// GET api/values/5
[HttpGet("{id}")]
public ActionResult Get(int id)
{
    return "value";
}

// POST api/values
[HttpPost]
public void Post([FromBody] string value)
{
}

// PUT api/values/5
[HttpPut("{id}")]
public void Put(int id, [FromBody] string value)
{
}

// DELETE api/values/5
[HttpDelete("{id}")]
public void Delete(int id)
{
}

}

在文档中,此控制器中的端点将显示如下:

/api/values (GET)

/api/values/{id} (GET)

/api/values (POST)

/api/values/{id} (PUT)

/api/values/{id} (DELETE)

相关内容

热门资讯

不能访问光猫的的管理页面 光猫是现代家庭宽带网络的重要组成部分,它可以提供高速稳定的网络连接。但是,有时候我们会遇到不能访问光...
【NI Multisim 14...   目录 序言 一、工具栏 🍊1.“标准”工具栏 🍊 2.视图工具...
Android|无法访问或保存... 这个问题可能是由于权限设置不正确导致的。您需要在应用程序清单文件中添加以下代码来请求适当的权限:此外...
银河麒麟V10SP1高级服务器... 银河麒麟高级服务器操作系统简介: 银河麒麟高级服务器操作系统V10是针对企业级关键业务...
北信源内网安全管理卸载 北信源内网安全管理是一款网络安全管理软件,主要用于保护内网安全。在日常使用过程中,卸载该软件是一种常...
安卓文字转语音tts没有声音 安卓文字转语音TTS没有声音的问题在应用中比较常见,通常是由于一些设置或者代码逻辑问题导致的。本文将...
APK正在安装,但应用程序列表... 这个问题可能是由于以下原因导致的:应用程序安装的APK文件可能存在问题。设备上已经存在同名的应用程序...
​ToDesk 远程工具安装及... 目录 前言 ToDesk 优势 ToDesk 下载安装 ToDesk 功能展示 文件传输 设备链接 ...
AWSECS:访问外部网络时出... 如果您在AWS ECS中部署了应用程序,并且该应用程序需要访问外部网络,但是无法正常访问,可能是因为...
报告实验.pdfbase.tt... 这个错误通常是由于找不到字体文件或者文件路径不正确导致的。以下是一些解决方法:确认字体文件是否存在:...