.NetCore3.1——Swagger简单配置使用

最新推荐文章于 2025-05-17 16:06:26 发布

小学生_乔凡

最新推荐文章于 2025-05-17 16:06:26 发布

阅读量3.4k

点赞数

CC 4.0 BY-SA版权

分类专栏： .netCore日常使用文章标签： .net

本文链接：https://blog.csdn.net/qq_40579788/article/details/103781176

.netCore日常使用专栏收录该内容

26 篇文章

订阅专栏

本文详细介绍了如何在.NetCore3.0-3.1中安装和配置Swagger，包括通过命令行或Nuget安装Swashbuckle.AspNetCore，以及在Startup.cs中配置服务和中间件的具体步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

.NetCore3.0-3.1版本 Swagger

一、安装Swagger
根据官网文档安装Swashbuckle.AspNetCore 在这里插入图片描述
命令行Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4
也可以通过Nuget搜索Swashbuckle.AspNetCore 安装
此处要注意包的版本问题
二、配置
在Startup中配置服务如图

            //注册swagger
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1.0", new OpenApiInfo { Title = "云小励平台接口", Version = "1.0" });
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
            });

在这个步骤的时候需要在项目的属性中设置生成XML文件，右击项目选择属性——>生成——>选中XML文档生成
在这里插入图片描述
这样设置好以后就swagger服务就算完工了
接下来就是在中间件配置了

 //Swagger规范和Swagger UI
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "云小励平台(V 1.0)");
                c.RoutePrefix = string.Empty;
            });

c.RoutePrefix = string.Empty 设置了这个就不用设置启动浏览器为Swagger了，如果没有这个的话启动浏览器还是要设置成Swagger,可以同时都进行设置。
设置启动浏览器项目右击属性——>调试——>启动浏览器
在这里插入图片描述
这里由于我设置c.RoutePrefix = string.Empty所以可以看到我的启动浏览器是空的，当然也是可以写上Swagger 这两个同时设置了并不冲突

接下来就是Swagger的规范文档了 Swagger 规范。这个我用的与之前一样的，我在之前的博客中有写。

创建一个swagger.json的文件贴入以下代码

{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "HYZH_API"
  },
  "paths": {
    "/api/Values": {
      "get": {
        "tags": [ "Values" ],
        "summary": "Get values",
        "operationId": "Get",
        "consumes": [],
        "produces": [ "text/plain", "application/json", "text/json" ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Success",
            "schema": {
              "uniqueItems": false,
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      },
      "post": {
        "tags": [ "Values" ],
        "operationId": "Post",
        "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ],
        "produces": [],
        "parameters": [
          {
            "name": "value",
            "in": "body",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success"
          }
        }
      }
    }
  },
  "definitions": {}
}