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)

相关内容

热门资讯

每日必看教程开挂攻略!指尖四川... 每日必看教程开挂攻略!指尖四川麻将多功能开挂攻略,指尖四川麻将切实真的是有开挂攻略1、指尖四川麻将辅...
实测必看作弊器技巧!梦黄麻将多... 实测必看作弊器技巧!梦黄麻将多功能作弊器技巧,梦黄麻将果然存在有作弊器技巧1、梦黄麻将免费脚本咨询教...
研究成果辅助器教程!小白大作战... 研究成果辅助器教程!小白大作战多功能辅助器教程,小白大作战确实真的有辅助器教程所有人都在同一条线上,...
分享认知辅助软件!小闲巴渝棋牌... 分享认知辅助软件!小闲巴渝棋牌多功能辅助软件,小闲巴渝棋牌竟然是有辅助软件1、不需要AI权限,帮助你...
分享认知透视器app!温岭逸趣... 分享认知透视器app!温岭逸趣麻将多功能透视器app,温岭逸趣麻将真是是有透视器app1)温岭逸趣麻...
专业讨论作弊器插件!欢乐划水麻... 专业讨论作弊器插件!欢乐划水麻将多功能作弊器插件,欢乐划水麻将果然真的是有作弊器插件1、用户打开应用...
最新技巧外挂攻略!逍遥皖北棋牌... 最新技巧外挂攻略!逍遥皖北棋牌多功能外挂攻略,逍遥皖北棋牌都是存在有外挂攻略亲,关键说明,逍遥皖北棋...
今日公布辅助app!乐通多功能... 今日公布辅助app!乐通多功能辅助app,乐通一直有辅助app1、乐通破解器简单,乐通机器人操作,乐...
揭秘一下辅助攻略!青橙竞技多功... 揭秘一下辅助攻略!青橙竞技多功能辅助攻略,青橙竞技一贯真的是有辅助攻略1、玩家可以在青橙竞技线上大神...
推荐一款透视挂技巧!无锡麻将多... 推荐一款透视挂技巧!无锡麻将多功能透视挂技巧,无锡麻将原来有透视挂技巧1、起透看视 无锡麻将辅助软件...