首页 > 其他分享 >.NetCore【中间件】API文档Swagger

.NetCore【中间件】API文档Swagger

时间:2022-12-05 21:58:07浏览次数:64  
标签:swagger 中间件 v1 API 文档 Swagger

Swagger

为API接口生成文档

Core中添加Swagger

  1. nuget安装包
install-package Swashbuckle.AspNetCore
  1. 注册服务
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();

    
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { 
        Title = "My API", 
        Version = "v1" 
      });
        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
        c.IncludeXmlComments(xmlPath, true); //添加控制器层注释(true表示显示控制器注释)
    });
}

  1. 使用服务

    // 启用中间件为生成的 JSON 文档和 Swagger UI 提供服务
    app.UseSwagger();

    // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
    // specifying the Swagger JSON endpoint.
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
     //c.RoutePrefix = string.Empty; 
    });

 

  1. 忽略XML注释警告

右键项目属性>生成>错误和警告添加 1591

源码

标签:swagger,中间件,v1,API,文档,Swagger
From: https://www.cnblogs.com/thomerson/p/16953652.html

相关文章

  • .NET7 Preview4 之OpenAPI swagger改进
    在MiniAPI系列中,《.NET6之MiniAPI(十八):OpenAPIswagger》介绍了swagger在MiniAPI框架中的使用,当时留下很多不足,随着.NET7Preview4的推出,这方面得到了很大的改进,我还是......
  • .NET7 Preview4 之OpenAPI swagger改进
    在MiniAPI系列中,《.NET6之MiniAPI(十八):OpenAPIswagger》介绍了swagger在MiniAPI框架中的使用,当时留下很多不足,随着.NET7Preview4的推出,这方面得到了很大的改进,我还是使......
  • .NET7 Preview4 之OpenAPI swagger改进
    在MiniAPI系列中,《.NET6之MiniAPI(十八):OpenAPIswagger》介绍了swagger在MiniAPI框架中的使用,当时留下很多不足,随着.NET7Preview4的推出,这方面得到了很大的改进,我还......
  • 5:IO Stream-Java API 实战
    (目录)1.相对论和IO流之说Input/OutputStream词典中Stream的意思是有方向性的流动的液体/电流,强调过程理解I/OStream可以看作是输入/输出方向的流体从相对论的角......
  • Web API-day02
    WebAPI第二天>>>>>>>事件什么是事件?事件是在编程时系统内发生的动作或者发生的事情比如用户在网页上单击一个按钮什么是事件监听?就是让程序检测是否有事件产生,一......
  • 常用API
    API(ApplicationProgrammingInterface):应用程序编程接口JavaAPI:指的就是JDK中提供的各种功能的Java类。Scanner一个简单的文本扫描程序,可以获取基本类型数据......
  • 个人微信开发API,微信机器人
    微信个人号二次开发,基于API开发可以有很多功能模块各种知名SCRM系统、客服平台都是根据此API二次开发的。好友管理:添加好友、删除好友、修改备注、创建标签、获取好友列......
  • 4k字介绍 React Router 6.4 超大变化:引入 Data API。你不纯粹了!
    背景最近,我在着手重构我的​​《联机桌游合集》​​。后端逻辑已经用Golang重构完毕,正在重构前端代码。之前我将每个桌游当作一个独立的前端项目,每个项目是通过我定义的脚......
  • 获取网易云音乐开放接口api的推荐歌单
    网易云音乐开放api接口网址:https://binaryify.github.io/NeteaseCloudMusicApi/#/?id=neteasecloudmusicapi项目地址:https://github.com/Binaryify/NeteaseCloudMusicAp......
  • 车载测试系列:自动驾驶中间件SOME/IP
    一、以太网引入汽车2004年,宝马汽车的OBD诊断口采用的是高速CAN总线,速率为500kbit/s,除去CAN协议本身的开销,通过OBD口升级控制器的净升级速度降到200kbit/s。预计到2008年,软件......