首页 > 编程语言 >从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(一)

从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(一)

时间:2023-04-11 18:12:36浏览次数:40  
标签:Web ASP 单击 Core 如下 API NET Swagger

一、创建ASP.NET Core Web API项目(若项目已创建,则可跳过本节内容)

1、双击打开VS2022。

2、单击“创建新项目”,如下图。

3、选择“ASP.NET Core Web API”类型,然后单击“下一步”,如下图。

4、“项目名称”此处填写为“AllTestDemo”;“位置”此处放在E盘根目录;“解决方案名称”此处默认与“项目名称”保持一致;不勾选“将解决方案和项目放在同一目录中”选择框。然后单击“下一步”,如下图。

5、“框架”此处选择“.NET 5.0”;“身份验证类型”此处选择“无”;勾选“配置HTTPS”选择框;不勾选“启用Docker”选择框;不勾选“启用OpenAPI支持”选择框。然后单击“创建”,如下图。

6、此时就可以得到一份ASP.NET Core Web API框架的项目,如下图。

二、引用NuGet包

1、在(上述)项目中鼠标右键单击“依赖项”,在弹出的菜单中单击“管理NuGet程序包”,如下图。

2、此时在出现的界面中选择“浏览”选项卡,并在搜索框中输入“Swashbuckle.AspNetCore”,在搜索结果中选择如下图中所框选的选项,然后单击右侧的“安装”,如下图。

3、安装完成后可以在“依赖项”中找到刚刚安装的依赖包,如下图。

三、配置服务

1、打开Startup.cs文件,在Startup类的ConfigureServices方法中如下图所示的地方添加如下所示的代码段。

            #region Swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("DocV1", new OpenApiInfo
                {
                    Version = "v0.1.0",
                    Title = "ZOHC测试文档",
                    Description = "一个Swagger教程文档",
                    Contact = new OpenApiContact
                    {
                        Name = "张欧昊辰",
                        Email = "[email protected]"

                    }
                });
            });
            #endregion

2、再次打开Startup.cs文件,在Startup类的Configure方法中如下图所示的地方添加如下所示的代码段。

            #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/DocV1/swagger.json", "DocV1");
            });
            #endregion

四、查看效果

按F5启动项目,运行成功后,修改浏览器中默认地址 https://localhost:44390/weatherforecast 为 https://localhost:44390/swagger 并按回车键,便可以看到Swagger界面了,如下图。

-------------------------------本篇文章到此结束-------------------------------------

 

标签:Web,ASP,单击,Core,如下,API,NET,Swagger
From: https://www.cnblogs.com/iZOHC/p/17290105.html

相关文章

  • 3D开发工具HOOPS最新解析合集!助力实现web端高性能模型渲染!
     一、3D技术为创新提供强大助力(1)3D专家提供专属技术支持服务不管您想搭建桌面、WEB或者移动端APP应用,技术领先全球的HOOPSPlatform组件都可以为您提供弹性的3D集成架构,同时,一批可信任的工业领域3D技术专家也将为您提供技术支持服务。(2)多平台自由且快速地转换如果您的客户期望......
  • Raspberry Pi crontab not work bug All In One
    RaspberryPicrontabnotworkbugAllInOneRaspberryPicrontab不执行bug???pi@raspberrypi:~/Desktop$sudocrontab-epi@raspberrypi:~/Desktop$sudocrontab-l#Editthisfiletointroducetaskstoberunbycron.##Eachtasktorunhastobe......
  • ASP.NET Post, FromBody 接参总是null 空值. Web api 前端传递是有值的,怎么回事?
    遇到一个常见错误,前端Post传递data:{array:[1,2,3]},但是API接收的一直是nullAPI方法postApi([FromBody]int[]array,[FromUri]intnum)Debug过程F12检查数据传递结构,没有问题尝试排除法,只保留[FormBody]。postApi([FromBody]int[]array)还是不行。根据网......
  • vue项目中webpack编译glsl文件的配置
    1、 安装webpack-glsl-loader npminstallwebpack-glsl-loader2、修改vue.config.js配置,添加内容如下module.exports=defineConfig({configureWebpack:(config)=>{config.module.rules.push({test:/\.glsl$/,use:[......
  • pod install libwebp 问题
    1.find/Users/***/.cocoapods/repos-inamelibwebp出现如下展示:/Users/***/.cocoapods/repos/cocoapods/Specs/1/9/2/libwebp/Users/***/.cocoapods/repos/master/Specs/1/9/2/libwebp(版本不同可能没有master,找不到找/Users/***/.cocoapods/repos/cocoapods/Specs/1/9/2/libwe......
  • Raspberry Pi GPIO 图解教程 All In One
    RaspberryPiGPIO图解教程AllInOneRaspberryPi&GPIOGPIO图解GPIOhttps://www.raspberrypi.com/documentation/computers/os.html#gpio-and-the-40-pin-header$pinouthttps://pinout.xyzGPIO(GeneralPurposeIO)SPI(SerialPeripheralInterface)I......
  • webpack体验
    1、首先建立npm环境npminit-y2、导入包webpack、webpack-cli、webpack-dev-server、html-webpack-pluginnpminstallwebpackwebpack-dev-serverwebpack-clihtml-webpack-plugin-d3、新建webpack.config.js配置文件constHtmlWebpackPlugin=require('html-we......
  • 前端webpack开发阶段解决跨域问题
    通过配置代理解决  1'/API':{2target:'https://xiaoapi.cn/API',//你请求的第三方接口3logLevel:"debug",//开启debug模式后,可在终端查看代理的真实请求地址4//ws:true,//代理websockets5changeOrigin:true,/*在......
  • .NET Core MongoDB数据仓储和工作单元模式实操
    前言MongoDB从入门到实战的相关教程YyFlight.ToDoList项目源码地址MongoDB事务使用前提说明创建EntityBase公共类添加UserInfo用户表实体映射模型创建用户Repository创建用户管理业务代码UserOperationExample控制创建注册数据库基础操作和工作单元注册相关应用服务......
  • 由ASP.NET Core读取Response.Body引发的思考
    由ASP.NETCore读取Response.Body引发的思考 前言#    前几天有群友在群里问如何在我之前的文章《ASP.NETCoreWebApi返回结果统一包装实践》的时候有点疑问,主要的疑问点就是关于Respouse的读取的问题。在之前的文章《深入探究ASP.NETCore读取Request.Body的正确方式......