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)

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...