首页 > 其他分享 >net6 webapi swagger 中文\版本说明

net6 webapi swagger 中文\版本说明

时间:2024-01-17 18:35:01浏览次数:29  
标签:webapi Name ApiVersionInfo public 版本 net6 swagger options

1、新建 ApiVersionInfo.cs 版本文件;

/// <summary>
/// API版本
/// </summary>
public class ApiVersionInfo
{
   public static string 接口版本1;
}

右键编辑项目文件;

<PropertyGroup>
      <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

右键属性,在输出勾选生成api文档的文件;

 

2、Program.cs

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddSwaggerGen(options =>
{
    foreach (FieldInfo fileld in typeof(SeatSyatem.ApiVersionInfo).GetFields())
    {
        options.SwaggerDoc(fileld.Name, new OpenApiInfo
        {
            Version = fileld.Name,
            Title = "API信息表",
            Description = $"API描述,{fileld.Name}版本"
        });

    }
    var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    //IncludeXmlComments 第二参数 true 则显示 控制器 注释
    options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename), true);
});

var app = builder.Build();

app.UseSwagger();
//生成对应 swagger.json
app.UseSwaggerUI(options =>
{
    foreach (FieldInfo field in typeof(SeatSyatem.ApiVersionInfo).GetFields())
    {
        options.SwaggerEndpoint($"/swagger/{field.Name}/swagger.json", $"{field.Name}");
    }
});

3、在接口文件中写注释

    /// <summary>
    /// 信息读写接口
    /// </summary>
    [ApiController]
    [Route("[controller]")]
    [ApiExplorerSettings(GroupName = nameof(ApiVersionInfo.接口版本1))]
    public class RData : ControllerBase
    {
        /// <summary>
        /// 保存信息
        /// </summary>
        /// <returns>返回code</returns>
        [HttpPost]
        public string Post()
        {
            return "";
        }

 

标签:webapi,Name,ApiVersionInfo,public,版本,net6,swagger,options
From: https://www.cnblogs.com/yingshiyu/p/17970711

相关文章

  • net6 webapi cors 跨域
    1、nuget安装microsoft.aspnetcore.cors2、program.cs文件中usingSystem.Reflection;usingMicrosoft.OpenApi.Models;varbuilder=WebApplication.CreateBuilder(args);//设置跨域builder.Services.AddCors(options=>{options.AddPolicy("Cors",builder......
  • 前后端分离,Asp.net core webapi 简单 2 步,轻松配置跨域
    前言可以说,前后端分离已经成为当今信息系统项目开发的主流软件架构模式,微服务的出现,让前后端分离发展更是迅速,大量优秀的前端框架如vue.js、react的出现,也让前后端分离趋势加快。所谓的前后端分离软件架构模式,就是指将前端和后端的开发完全分离,后端负责提供API接口和数据处理......
  • 盘点一下在swagger中一些有用且经常忽略的属性
    震惊!,这些Swagger的属性你都了解吗?盘点一下在swagger中一些有用且经常忽略的属性启用永久授权EnablePersistAuthorizationapp.UseSwaggerUI(c=>{//指定SwaggerJSON文件的终结点,用于加载和显示API文档。......
  • Django 使用swagger自定义自动生成类
    完整代码:https://gitee.com/mom925/django-system之前写的Django配置swagger(https://www.cnblogs.com/moon3496694/p/17657283.html)其实更多还是自己手动的写代码去书写接口文档,我希望它能更加的自动化生成出接口文档,所以我需要自己重写一些函数。安装所需的包,注册app,注册路由参考......
  • C#调用webapi发送带json参数的post请求
    嗯。。很久不更新,因为跳槽新公司了,要学的东西太多太忙了。也没时间记录,今天又写了一个C#调用webapi发送带json参数的post请求拿数据的方法,所以来到这里记录一下///<paramname="url">请求地址</param>///<paramname="jsonParas">请求体</param>///<paramnam......
  • net6 net8 发布失败的几个bug应急办法
    定位了几个发布失败的错误,问了微软,感觉还是应急办法,目前还未修复,VS版本202217.8.3 net6引用最新hosting后发布win-x64win-x86错误项目配置:<ProjectSdk="Microsoft.NET.Sdk"><PropertyGroup><OutputType>WinExe</OutputType><TargetFramework>net6.0-......
  • JavaScript WebAPI(三)(详解)
    这次介绍一下webAPI中的一些知识:回调函数回调函数是指如果将函数A做为参数传递给函数B时,我们称函数A为回调函数例如://立即执行函数中传递的函数是一个回调函数(function(){console.log("我是回调函数")})();//监听事件中传递的参数是一个回调函数constdiv=document......
  • JavaScript WebApi(二) 详解
    监听事件介绍事件监听是一种用于在特定条件下执行代码的编程技术。在Web开发中,事件监听器可以用于捕获和响应用户与页面交互的各种操作,如点击、滚动、输入等。事件监听的基本原理是,通过在特定元素上注册事件监听器,当事件在该元素上触发时,相应的处理函数会被执行。以下是事件监听的......
  • JavaScript WebApi 一(详讲)
    基础知识在前面的部分已经讲过了,大家如果没有学习过JavaScript的可以去看一下1.DOM引入在JavaScript中,DOM(文档对象模型)提供了一种表示和操作HTML文档的方式。在DOM中,文档被表示为一个由节点组成的树形结构。DOM对象则是这些节点的抽象表示,它们可以通过JavaScript来访问和操作。DOM......
  • springboot集成swagger knife4j 最详细的步骤 手把手教你继承swagger
    springboot集成swaggerknife4j最详细的步骤手把手教你继承swagger效果图Knife4j介绍Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目一开始项目初衷是为了写一个增强版本的swagger的前端ui,但是随着项目的发展,面对越来越多的个性......