栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > .Net

.NET 5.0 WebAPI + Swagger 部署到IIS

.Net 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

.NET 5.0 WebAPI + Swagger 部署到IIS

.NET 5.0 WebAPI + Swagger 部署到IIS

文章目录
  • .NET 5.0 WebAPI + Swagger 部署到IIS
  • 一、使用 ASP.NET Core 创建 Web API
  • 二、发布WebAPI
  • 三、在IIS上部署
  • 三、问题
  • 总结


一、使用 ASP.NET Core 创建 Web API




选择ASP.NET Core 5.0,默认勾选Enable OpenAPI support,项目模板会创建一个支持Swagger的API。取消勾选为HTTPS配置,因为HTTPS需要SSL证书。

创建后的WebAPI项目结构如下图所示:

Visual Studio 将启动:

  • IIS Express Web 服务器。
  • 默认浏览器,并导航到 https://localhost:/swagger/index.html,其中
    是随机选择的端口号。


安装Microsoft.Extensions.PlatformAbstractions包,为每个方法和方法的参数添加注释

修改Startup.cs中的 ConfigureServices方法:

public void ConfigureServices(IServiceCollection services)
{

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

为接口添加注释:

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace TestWebAPI.Controllers
{
    /// 
    /// 天气控制器
    /// 
    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        private static readonly string[] Summaries = new[]
        {
            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        };

        private readonly ILogger _logger;

        public WeatherForecastController(ILogger logger)
        {
            _logger = logger;
        }

        /// 
        /// 获取天气
        /// 
        /// 
        [HttpGet]
        public IEnumerable Get()
        {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }
    }
}

项目右键,选择属性,勾选“XML文档文件”,如下图所示:

二、发布WebAPI






三、在IIS上部署




https://dotnet.microsoft.com/download下载dotnet -hosting

三、问题

打开发布到iis的文件夹下的web.config文件,添加以下代码:



  
    
      
        
      
      
        
          
        
      
    
  


总结

问题:Not Found /swagger/v1/swagger.json

https://stackoverflow.com/questions/48450262/asp-net-core-swashbuckle-not-creating-swagger-json-file
这点我做个解释,发布到IIS上时,如果是在Default Web Site下添加应用程序,就会有”别名“

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/905682.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号