首页 \ 问答 \ 用Swagger隐藏服务(Hiding services with Swagger)

用Swagger隐藏服务(Hiding services with Swagger)

 有什么方法可以在进入生产时从swagger UI中隐藏某些服务但是在localhost上运行时会显示？  
 EX：  
    /// <summary>
    /// GET: .../api/SomeController/{id: int}
    /// </summary>
    /// <param name="id">int</param>
    /// <returns></returns>
public IHttpActionResult SomeService(int id) { return Ok();}
 
 当我在我的环境中运行并且去swagger UI localhost：12345 / swagger / ui / index我会看到服务文档等，但是当我在http：// someDomain / swagger / ui / index时我不会看见。  
 我一直在查看文档，但没有找到任何与此相关的内容。  
 谢谢。 

is there any way that some services can be hidden from swagger UI when going into production but when run on localhost be displayed? 
EX: 
    /// <summary>
    /// GET: .../api/SomeController/{id: int}
    /// </summary>
    /// <param name="id">int</param>
    /// <returns></returns>
public IHttpActionResult SomeService(int id) { return Ok();}
 
When i'm running on my environment and go to swagger UI localhost:12345/swagger/ui/index i will see that service documentation etc, but when i'm on http://someDomain/swagger/ui/index i will not see it. 
I've been looking in the documentation but didn't find anything related to this. 
Thank you.

原文：https://stackoverflow.com/questions/41037162

更新时间：2021-06-17 11:06

最满意答案

 您可以创建自己的属性并使用它从swagger中排除该方法或整个控制器：  
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class HideInDocsAttribute:Attribute
{
}
 
 接着：  
public class HideInDocsFilter:IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer, IHostingEnvironment env)
    {
        if(env.IsEnvironment("Production")) {
            foreach (var apiDescription in apiExplorer.ApiDescriptions)
            {
                if (!apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any() && !apiDescription.ActionDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any()) continue;
                var route = "/" + apiDescription.Route.RouteTemplate.TrimEnd('/');
                swaggerDoc.paths.Remove(route);
            }
        }            
    }
}

You can create your own attribute and use it to exclude that method or whole controller from swagger: 
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class)]
public class HideInDocsAttribute:Attribute
{
}
 
And then: 
public class HideInDocsFilter:IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer, IHostingEnvironment env)
    {
        if(env.IsEnvironment("Production")) {
            foreach (var apiDescription in apiExplorer.ApiDescriptions)
            {
                if (!apiDescription.ActionDescriptor.ControllerDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any() && !apiDescription.ActionDescriptor.GetCustomAttributes<HideInDocsAttribute>().Any()) continue;
                var route = "/" + apiDescription.Route.RouteTemplate.TrimEnd('/');
                swaggerDoc.paths.Remove(route);
            }
        }            
    }
}

用Swagger隐藏服务(Hiding services with Swagger)

最满意答案

相关问答

如何发布文件在swagger？(How to post files in Swagger (OpenAPI)?)[2021-06-07]

Apache Wink与Swagger集成(Apache Wink integration with Swagger)[2021-07-02]

Swagger UI无法正常显示(Swagger UI doesn't display properly)[2021-09-09]

Swagger与使用过滤器构建的服务集成(Swagger integration with service built using filters)[2021-11-11]

泽西岛2 Swagger配置(Jersey 2 Swagger configuration)[2021-08-12]

用Swagger隐藏服务(Hiding services with Swagger)[2021-06-17]

Node.js Swagger - 使用多个文件(Node.js Swagger - using multiple files)[2021-05-16]

如何在Azure Easy API中启用Swagger UI(How to enable Swagger UI in Azure Easy API)[2020-12-15]

导入Swagger端点时出错(Error importing Swagger Endpoint)[2021-09-05]

Swagger问题与Autofac(Swagger issue with Autofac)[2021-03-28]

相关文章

最新问答