• .Net WebApi 添加Swagger


    前言

    随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。
    前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。

    安装

    1. 首先,创建WebApi类型的项目 TestSwagger

            

            2. 安装Swashbuckle 包和swagger.Net.UI包

          

      3. 安装完成之后,可以看到这些类与文件都是安装完成时swagger添加的

          

    设置

    1. 设置输出xml文档文件
      右键项目属性—>生成—>勾选XML文档文件

           

    运行

    发生上述错误,请在,SwaggerNet.cs中,注释类上面的两行

     结果又报以下错误:

        

    这时需要在SwaggerConfig.cs 文件中 GlobalConfiguration.Configuration.EnableSwagger  添加c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

    需要添加注释则加:   c.IncludeXmlComments(string.Format("{0}/bin/TestService.XML", System.AppDomain.CurrentDomain.BaseDirectory));

    需要在Swagger页面添加自定义header:

    需要在SwaggerConfig.cs 文件中 c.OperationFilter<AddAuthorizationHeaderParameterOperationFilter>();

    增加新类:

    namespace TestService.App_Start
    {
        public class AddAuthorizationHeaderParameterOperationFilter : IOperationFilter
        {
            public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
            {
    
                if (operation.parameters == null)
                {
                    operation.parameters = new List<Parameter>();
                }
                operation.parameters.Add(new Parameter
                    {
                        name = "UserId",
                        @in = "header",
                        description = "User short name",
                        required = true,
                        type = "string"
                    });
    
                operation.parameters.Add(new Parameter
                {
                    name = "ClientId",
                    @in = "header",
                    description = "Client generated unique number",
                    required = true,
                    type = "string"
                });
            }
        }
    }
    

      显示效果

  • 相关阅读:
    cocostudio 使用教程
    anrdroid AVD启动不起来的问题。Waiting for HOME ('android.process.acore') to be launched
    Android SDK无法更新的问题解决办法
    Code(容斥,好题)
    莫比乌斯反演(转)
    随笔--新建查询
    11427
    uva11722
    uva11021
    How many integers can you find(容斥+dfs容斥)
  • 原文地址:https://www.cnblogs.com/suidouya/p/9602492.html
Copyright © 2020-2023  润新知