Swagger 接口展现

请在对应WebApi项目中引入Aegis.Extensions.Swagger的Nuget包(框架版本须2.0+)

启用Swagger

  1. 请确保在Component.deps.json中的ServicesMiddlewares里均引入Swagger,如下述代码里的Swagger部分。

    {
    "Components": {
     "Services": [ "Logging","Swagger","IdGenerator","BusinessServices","Authorization","RequestValidation","EventBus","SsoAuthorize"],
     "Middlewares": ["Swagger","Authorization"]
    },
    }
    
  2. 请确保在AppSettings或者加载的配置文件中包含Swagger节点的配置,具体如下:

    "Swagger":{  
    "IsEnabled": true,   //Swagger启用开关, true为开启
    "Title": "Aegis-Demo",   //Swagger显示Title
    "Version": "v1",   //Swagger版本号
    "XmlCommentsPath": "{CurrentDirectory}/Aegis.Webapi.BaseDemo.xml",   //Xml文档路径,注意这里只能填写绝对路径,{CurrentDirectory}为占位符,会自动替换为当前程序目录
    "SecurityScheme": {  
     "SecurityEnabled": true,   //是否启用安全校验头
     "AddBearerHeader": true,   //是否添加Bearer的Header
     "BearerName": "Authorization",   //Bearer Header名,Aegis的认证和鉴权均使用的是Authorization,建议不修改
     "Description": "Value Bearer {token}"   //Header 说明
    }  
    }
    
  3. 请确保对应Xml路径生成了项目xml文档。参考下图: image.png

  4. 运行WebApi即可查看效果。

results matching ""

    No results matching ""