当前位置: 首页 > news >正文

使用Scalar.AspNetCore来管理你的OpenApi(二)

这是一个上一篇的补充文档,感谢@TopStop回复的内容,上篇中提到了在.net 10中,多了一个xml文档注释的支持

使用Scalar.AspNetCore来管理你的OpenApi

 

官方参考

https://learn.microsoft.com/zh-cn/aspnet/core/fundamentals/openapi/openapi-comments?view=aspnetcore-10.0

启用xml文档支持方法

在项目文件中启用 XML 文档

<Project Sdk="Microsoft.NET.Sdk"><PropertyGroup><TargetFramework>net10.0</TargetFramework><ImplicitUsings>enable</ImplicitUsings><Nullable>enable</Nullable><GenerateDocumentationFile>true</GenerateDocumentationFile></PropertyGroup></Project>

或者在VS里,项目——项目属性——生成——输出——勾选“文档文件”

屏幕截图 2025-12-13 162428

下面编辑正常的注释,就会生成为API文档了。

屏幕截图 2025-12-13 161740

 

namespace WebApplication1
{/// <summary>/// 获取城市天气/// </summary>/// <remarks>获取天气情况</remarks>public class WeatherForecast{/// <summary>/// 日期/// </summary>/// <remarks>日期</remarks>public DateOnly Date { get; set; }/// <summary>/// 摄氏度/// </summary>/// <remarks>摄氏度</remarks>public int TemperatureC { get; set; }/// <summary>/// 华氏度/// </summary>/// <remarks>华氏度</remarks>public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);/// <summary>/// 总结/// </summary>/// <remarks>总结</remarks>public string? Summary { get; set; }/// <summary>/// 参数/// </summary>/// <remarks>参数</remarks>public int id {  get; set; }}
}

 

/// <summary>
/// 获取城市天气
/// </summary>
/// <remarks>获取天气情况</remarks>
/// <param name="id">城市名称</param>
/// <response code="200">正常返回.</response>
/// <response code="404">出错返回.</response>
/// <example>{"name":"Sample","value":42}</example>
/// <param name="id" example="42">The unique identifier</param>
[HttpGet(Name = "GetWeatherForecast")]public IEnumerable<WeatherForecast> Get()
{return Enumerable.Range(1, 5).Select(index => new WeatherForecast{Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),TemperatureC = Random.Shared.Next(-20, 55),Summary = Summaries[Random.Shared.Next(Summaries.Length)]}).ToArray();
}

 

http://www.jsqmd.com/news/83177/

相关文章:

  • Neo4j极简入门:30分钟学会图数据库
  • Python sleep函数:从入门到精通的5个实例
  • 包头租车哪家强?2025年度口碑租车公司TOP5推荐,包头市租车公司解决方案与实力解析 - 品牌推荐师
  • CodeBlocks实战:用AI快速开发学生成绩管理系统
  • CodeBlocks开发效率翻倍:AI对比传统编程方式
  • 如何用AI快速解决EFI网络启动问题
  • 终极企业网站模板:Start Bootstrap Modern Business完全指南
  • Sa-Token vs Shiro:新一代权限框架的效率对比
  • 2025年度哈氏合金C276焊管五大资深优质靠谱厂家排行榜, - 工业品牌热点
  • Neo4j vs SQL:图数据库效率对比实测
  • 2025年五大双相不锈钢企业推荐,双相不锈钢大型厂家及个性化 - 工业推荐榜
  • AI如何助力打造智能学习导航系统
  • 2025年哈氏合金卷板制造厂五大推荐,老牌厂家与加工企业全解 - 工业推荐榜
  • Java新手必学:5分钟掌握Collections.singletonList
  • 2025年四季度表面污染检测仪行业供应商综合实力盘点 - 品牌推荐大师
  • 精华油如何选对不选贵?2025年年终最新成分解析与5款专家严选产品推荐 - 品牌推荐
  • AI如何帮你快速生成VBA支持库代码?
  • 智慧实验室哪家好?实验室智控管理系统/实验室智慧物资管理系统优质供应商、源头厂家制造商推荐 - 品牌推荐大师1
  • 2025年年终品牌证明推荐:从方法论到实证案例的全方位横评,5家服务商核心能力与适配场景盘点 - 品牌推荐
  • 2025年双相不锈钢大型厂家TOP5权威推荐:老牌品牌供应商 - 工业品牌热点
  • 应对智能体AI安全威胁的七大核心技术策略
  • 2025年彩钢瓦成型机服务商厂家推荐:十大靠谱彩钢瓦成型机供 - myqiye
  • 20、PHP扩展与AJAX技术深度解析
  • 2025年年终品牌证明推荐:从方法论到实效证据的全方位对比,附不同企业需求下的5家机构适配清单 - 品牌推荐
  • 21、AJAX与PHP缓存引擎全解析
  • 2025年年终销量第一证明机构推荐:不同企业生命周期下的匹配策略及核心服务商推荐 - 品牌推荐
  • Folo翻译功能终极指南:轻松跨越语言障碍的完整方案
  • 为什么Awesome Vue能成为Vue开发者的终极资源宝库?
  • 2025年年终品牌证明推荐:从方法论到实效证据的全方位横评,附不同需求场景下的5家服务商清单 - 品牌推荐
  • 从Excel到爆款视频:Reddit内容创作效率提升600%的实战密码