webapi文档描述-swagger


使用swagger

  • 汉化及问题解决
  • ApiExplorer思路拓展
  • 总结
  • 回到顶部回到顶部回到顶部ApiExplorer.cs源码,使用GlobalConfiguration.Configuration.Services.GetApiExplorer().ApiDescriptions 即可查看所有Api接口地址相关信息,Swagger正是借助于该方法导出所有接口信息,在结合xml文档添加相应注释文成接口描述文档的。

    我们可以在Global.asax.cs  Application_Start中替换掉系统自带的ApiExploer服务,使用我们自己自定义的服务。

       public class CustomApiExplorer : ApiExplorer
        {
            public CustomApiExplorer(HttpConfiguration configuration) : base(configuration)
            {
            }
    
            public override bool ShouldExploreAction(string actionVariableValue, HttpActionDescriptor actionDescriptor, IHttpRoute route)
            {
                return base.ShouldExploreAction(actionVariableValue, actionDescriptor, route);
            }
    
            public override bool ShouldExploreController(string controllerVariableValue, HttpControllerDescriptor controllerDescriptor, IHttpRoute route)
            {
                return base.ShouldExploreController(controllerVariableValue, controllerDescriptor, route);
            }
        }
     GlobalConfiguration.Configuration.Services.Replace(typeof(IApiExplorer), new CustomApiExplorer(GlobalConfiguration.Configuration)); 
    接口有特有业务的可以考虑自定义ApiExplorer进行实现,或者在CachingSwaggerProvider中GetSwagge中进行实现。 回到顶部SwaggerDemo,参考资源:

          Swashbuckle:https://github.com/domaindrivendev/Swashbuckle

     

    如果,您认为阅读这篇博客让您有些收获,不妨点击一下右下角的【推荐】按钮。
    如果,您希望更容易地发现我的新博客,不妨点击一下绿。色通道的【关注我】。

    如果,想给予我更多的鼓励,求打

    因为,我的写作热情也离不开您的肯定支持。

    感谢您的阅读,如果您对我的博客所讲述的内容有兴趣,请继续关注我的后续博客,我是焰尾迭 。