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

这篇具有很好参考价值的文章主要介绍了从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(一)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

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

1、双击打开VS2022。

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

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

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

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

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

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

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

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

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

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

二、引用NuGet包

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

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

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

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

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

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

三、配置服务

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 = "izohc@foxmail.com"

                    }
                });
            });
            #endregion

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

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

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

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

四、查看效果

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

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

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

 文章来源地址https://www.toymoban.com/news/detail-410676.html

到了这里,关于从0到1手把手教你ASP.NET Core Web API项目配置接口文档Swagger(一)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【荣耀帐号服务】手把手教你快速web接入

    荣耀帐号开放服务基于OAuth2.0,Web应用可以获取用户授权凭证, 实现授权登录功能, 可以实现浏览器Web授权登录接入或者手机H5授权登录接入荣耀帐号。 1) 用户在应用网站上选择荣耀帐号登录 2) 应用服务器构造 /oauth2/v3/authorize 链接, 向荣耀帐号服务器发起授权请求 3) 荣耀帐号

    2024年02月10日
    浏览(40)
  • 在IIS上部署你的ASP.NET Core Web Api项目及Swagger

    与ASP.NET时代不同,ASP.NET Core不再是由IIS工作进程(w3wp.exe)托管,而是使用自托管Web服务器(Kestrel)运行,IIS则是作为反向代理的角色转发请求到Kestrel不同端口的ASP.NET Core程序中,随后就将接收到的请求推送至中间件管道中去,处理完你的请求和相关业务逻辑之后再将HTTP响

    2024年02月10日
    浏览(52)
  • 不会使用 EF Core 的 Code First 模式?来看看这篇文章,手把手地教你

    Code First 是 Entity Framework Core (简称 EF Core) 的一种开发模式,它允许开发人员使用纯粹的代码来定义数据模型,通过它,可以极大地提高开发效率: 使用 Code First 开发模式,你可以专注于定义领域模型和业务逻辑,而无需关注数据库的细节,能够更快地构建应用程序 Code F

    2024年02月04日
    浏览(50)
  • 手把手教你从0搭建SpringBoot项目

    用到的工具:idea 2021、Maven 3.6.3、postman 框架:SpringBoot、Mybatis 数据库:Mysql8.0.30 安装配置参考博文 注意: 1.下载maven注意idea与Maven版本的适配: 2.为了避免每次创建项目都要改Maven配置,可以修改idea创建新项目的设置 二、安装数据库 mysql8安装参考博文 **注意:**连接不上往

    2024年02月03日
    浏览(49)
  • web分析-手把手教你怎么写小程序事件分析

    概述 小程序提供了自定义埋点方法,需要在业务代码中新增对应的代码。 区别于小程序已有的页面、用户等埋点,web分析中的自定义的方法往往与业务场景相关。 本文会按步骤详细介绍小程序的事件、事件分析、漏斗分析的创建流程。 该事件主要用于记录用户进入首页之后

    2024年02月10日
    浏览(45)
  • 图文结合手把手教你创建SpringCloud项目

    前言 Spring Cloud 是一系列框架的有序集合,它利用 Spring Boot 的开发便利性简化了分布式系统的开发,比如服务注册、服务发现、网关、路由、链路追踪等。Spring Cloud 并不是重复造轮子,而是将市面上开发得比较好的模块集成进去,进行封装,从而减少了各模块的开发成本。也

    2024年04月25日
    浏览(58)
  • 手把手教你打造自己的AI聊天机器人程序(讯飞星火API)

    案例背景 最近发现科大的讯飞星火大模型可以申请API试用了,我一直想用chatgpt的API,一是因为收费买不起,二是因为网络不方便..... 现在有了科大讯飞这个国内免费的,当然要试试。 目前讯飞星火可以申请试用他们的模型API,但是只有200w的token上限(一下就能花光),而且

    2024年02月08日
    浏览(67)
  • 手把手教你将项目部署到服务器!

    一、导入centos7虚拟机: 打开VMWare,点击“打开虚拟机”,选择centos7.ova之后,选择存储路径: 点击导入: 选择“不再显示此消息”,点击“重试”按钮: 点击“编辑虚拟机设置”,修改处理器、内存、硬盘等信息后,启动 按Ctrl+Alt键可以切换到windows下。 启动成功后,输入

    2023年04月20日
    浏览(56)
  • 手把手教你用git上传项目到GitHub

    github的官方网址:https://github.com ,如果没有账号,赶紧注册一个。 点击Sign in进入登录界面,输入账号和密码登入github。 创建成功可以看到自己的仓库地址,如此,我的远程免费的仓库就创建了。它还介绍了github仓库的常用指令。这个指令需要在本地安装git客户端。 Git是目

    2024年01月18日
    浏览(52)
  • 手把手教你搭建 Webpack 5 + React 项目

    在平时工作中,为减少开发成本,一般都会使用脚手架来进行开发,比如 create-react-app 。脚手架都会帮我们配置好了 webpack,但如果想自己搭建 webpack 项目要怎么做呢?这边文章将介绍如何使用 webpack 5 来搭建 react 项目,项目地址在文末。 1.1 Webpack 的好处 试想在不使用任何打

    2024年02月08日
    浏览(44)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包