ASP.NETCore-传输端点架构Swagger文档。
创始人
2024-09-17 07:30:38
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)

相关内容

热门资讯

线上(wepoke真的)原来是... 线上(wepoke真的)原来是真的有挂!其实真的有挂(2022已更新)(哔哩哔哩);亲,其实确实真的...
两教程(Wepoke程序)软件... 两教程(Wepoke程序)软件透明挂辅助工具(软件透明挂)透视辅助(2024已更新)(哔哩哔哩);致...
软件(wepoke透明)原来是... 软件(wepoke透明)原来是真的有挂!其实真的有挂(2020已更新)(哔哩哔哩)是一款可以让一直输...
一模拟器(德扑工具)外挂辅助工... 一模拟器(德扑工具)外挂辅助工具(透视)透视辅助(2025已更新)(哔哩哔哩);亲真的是有正版授权,...
系统(aapoker讲解)竟然... 系统(aapoker讲解)竟然真的有挂!其实真的有挂(2021已更新)(哔哩哔哩);aapoker讲...
6系统(aapoker下载)外... 6系统(aapoker下载)外挂辅助工具(辅助挂)透视辅助(2023已更新)(哔哩哔哩)aapoke...
智能(德扑之星刷数据)果真真的... 智能(德扑之星刷数据)果真真的有挂!原来真的有挂(2025已更新)(哔哩哔哩);《WPK辅助透视》‌...
1机器人(德州nzt软件)软件... 1机器人(德州nzt软件)软件透明挂辅助软件(透视)透视辅助(2022已更新)(哔哩哔哩);人气非常...
ai代打(德扑之星决策)确实是... ai代打(德扑之星决策)确实是真的有挂!原来真的有挂(2020已更新)(哔哩哔哩);科技详细教程小薇...
第8透明(wepoke数据)外... 第8透明(wepoke数据)外挂透明挂辅助神器(辅助挂)透视辅助(2023已更新)(哔哩哔哩);原来...