如何使用 swashbuckle 为带有 Owin 的 WebApi 2 生成文档

本文介绍了如何使用 swashbuckle 为带有 Owin 的 WebApi 2 生成文档的处理方法，对大家解决问题具有一定的参考价值，需要的朋友们下面随着小编来一起学习吧！ 问题描述

我使用

下面是招摇的配置:

使用 System.Web.Http;使用 WebActivatorEx；使用 DC.SUMS.WebAPI1；使用 Swashbuckle.Application；使用系统；使用 System.Linq；使用 Swashbuckle.Swagger;使用 Swashbuckle.Dummy.SwaggerExtensions；[程序集:PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]命名空间 DC.SUMS.WebAPI1{公共类 SwaggerConfig{公共静态无效寄存器(){var thisAssembly = typeof(SwaggerConfig).Assembly;全局配置.配置.EnableSwagger(c =>{//默认情况下，服务根 url 是从用于访问文档的请求中推断出来的.//但是，在某些情况下(例如代理和负载平衡环境)可能不这样做//正确解析.您可以通过提供自己的代码来确定根 URL 来解决此问题.////c.RootUrl(req => GetRootUrlFromAppConfig());//如果 Swagger 2.0 文档中没有明确提供方案，则用于访问的方案//将文档作为默认值.如果您的 API 支持多种方案并且您希望明确//关于它们，您可以使用方案"选项，如下所示.////c.Schemes(new[] { "http", "https" });//使用SingleApiVersion"来描述单一版本的API.Swagger 2.0 包含一个Info"对象//保存 API 的附加元数据.版本和标题是必需的，但您也可以提供//通过将方法链接到 SingleApiVersion 的附加字段.//c.SingleApiVersion("v1", "DC.SUMS.WebAPI1");//如果您的 API 有多个版本，请使用MultipleApiVersions"而不是SingleApiVersion".//在这种情况下，您必须提供一个 lambda 来告诉 Swashbuckle 应该执行哪些操作//包含在给定 API 版本的文档中.像SingleApiVersion"，每次调用Version"//返回一个信息"构建器，以便您可以为每个 API 版本提供额外的元数据.////c.MultipleApiVersions(//(apiDesc, targetApiVersion) =>ResolveVersionSupportByRouteConstraint(apiDesc, targetApiVersion),//(vc) =>//{//vc.Version("v2", "Swashbuckle Dummy API V2");//vc.Version("v1", "Swashbuckle Dummy API V1");//});//您可以使用BasicAuth"、ApiKey"或OAuth2"选项来描述 API 的安全方案.//有关详细信息，请参阅 github/swagger-api/swagger-spec/blob/master/versions/2.0.md.//注意:这些只定义了方案，需要加上相应的安全"属性//在文档或操作级别指示操作需要哪些方案.去做这个，//您需要实现自定义 IDocumentFilter 和/或 IOperationFilter 来设置这些属性//根据你的具体授权实现////c.BasicAuth("基本")//.Description("基本 HTTP 身份验证");////c.ApiKey("apiKey")//.Description("API 密钥认证")//.Name("apiKey")//.In("标题");//c.OAuth2("oauth2").Description("OAuth2 隐式授权").Flow("隐式").AuthorizationUrl("localhost:8891/authorize").TokenUrl("localhost:8891/token").Scopes(范围=>{scopes.Add("read", "对受保护资源的读取权限");scopes.Add("write", "对受保护资源的写访问");});//设置此标志以省略任何使用 Obsolete 属性修饰的操作的描述//c.IgnoreObsoleteActions();//每个操作都被分配一个或多个标签，然后消费者出于各种原因使用这些标签.//例如swagger-ui根据每个操作的第一个标签对操作进行分组.//默认情况下，这将是控制器名称，但您可以使用GroupActionsBy"选项//用任何值覆盖.////c.GroupActionsBy(apiDesc => apiDesc.HttpMethod.ToString());//您还可以为组(由GroupActionsBy"定义)指定自定义排序顺序来指示//列出操作的顺序.例如，如果默认分组已就位//(控制器名称)并且您指定一个降序的字母排序顺序，然后从一个//ProductsController 将在来自 CustomersController 的那些之前列出.这通常是//用于自定义 swagger-ui 中的分组顺序.////c.OrderActionGroupsBy(new DescendingAlphabeticComparer());//如果你用注解控制器和 API 类型//XML 注释 (msdn.microsoft/en-us/library/b2s063f7(v=vs.110).aspx)，可以合并//将这些评论添加到生成的文档和 UI 中.您可以通过提供一个或//更多 XML 注释文件.//c.IncludeXmlComments(GetXmlCommentsPath());//Swashbuckle 尽最大努力为各种类型生成符合 Swagger 的 JSON 模式//在您的 API 中公开.但是，有时可能需要对输出进行更多控制.//这通过MapType"和SchemaFilter"选项支持:////使用MapType"选项覆盖特定类型的模式生成.//应该注意的是，生成的 Schema 将被放置在任何适用的操作的内联"中.//虽然 Swagger 2.0 支持所有"模式类型的内联定义，但 swagger-ui 工具不支持.//它期望单独定义和引用复杂"模式.因此，您应该只//当生成的 Schema 是原始类型或数组类型时，使用MapType"选项.如果你需要改变一个//复杂的 Schema，使用 Schema 过滤器.////c.MapType(() => new Schema { type = "integer", format = "int32" });//如果您想在生成复杂"模式后对其进行后期修改，全面或针对//特定类型，您可以连接一个或多个 Schema 过滤器.//c.SchemaFilter<ApplySchemaVendorExtensions>();//在 Swagger 2.0 文档中，复杂类型通常是全局声明的，并由 unique 引用//架构 ID.默认情况下，Swashbuckle 不会在 Schema Id 中使用完整的类型名称.在大多数情况下，这//效果很好，因为它可以防止类型命名空间的实现细节"泄漏到你的//Swagger 文档和 UI.但是，如果您的 API 中有多个具有相同类名的类型，您将//需要选择退出此行为以避免 Schema Id 冲突.////c.UseFullTypeNameInSchemaIds();//或者，您可以提供自己的自定义策略来推断 SchemaId 的//在您的 API 中描述复杂"类型.//c.SchemaId(t => t.FullName.Contains('`') ? t.FullName.Substring(0, t.FullName.IndexOf('`')) : t.FullName);//设置此标志以省略任何类型属性的模式属性描述//过时的属性c.IgnoreObsoleteProperties();//根据内置的 JsonSerializer，Swashbuckle 默认将枚举描述为整数.//你可以通过全局配置 StringToEnumConverter 来改变序列化器的行为//枚举类型.Swashbuckle 将开箱即用地兑现这一变化.但是，如果您使用不同的//将枚举序列化为字符串的方法，您也可以强制 Swashbuckle 将它们描述为字符串.//c.DescribeAllEnumsAsStrings();//与 Schema 过滤器类似，Swashbuckle 也支持 Operation 和 Document 过滤器:////通过连接一个或多个生成后修改操作描述//操作过滤器.//c.OperationFilter();////如果您已经定义了如上所述的 OAuth2 流，则可以使用自定义过滤器//检查每个操作的某些属性并推断需要哪些(如果有)OAuth2 范围//执行操作//c.OperationFilter();c.OperationFilter<AddFileUploadParams>();c.OperationFilter<SupportFlaggedEnums>();c.OperationFilter<UpdateFileDownloadOperations>();//通过连接一个或多个文档过滤器来后期修改整个 Swagger 文档.//这提供了修改最终 SwaggerDocument 的完全控制权.你应该有一个很好的了解//Swagger 2.0 规范.- github/swagger-api/swagger-spec/blob/master/versions/2.0.md//在使用此选项之前.//c.DocumentFilter<ApplyDocumentVendorExtensions>();//与 WebApi 相比，Swagger 2.0 在映射 URL 时不包含查询字符串组件//到一个动作.因此，如果 Swashbuckle 遇到多个操作，它会引发异常//使用相同的路径(无查询字符串)和 HTTP 方法.您可以通过提供//为 Swagger 文档选择获胜者或合并描述的自定义策略//c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());//使用附加行为(例如缓存)包装默认 SwaggerGenerator 或提供//带有 CustomProvider 选项的 ISwaggerProvider 的替代实现.////c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider));}).EnableSwaggerUi(c =>{//使用InjectStylesheet"选项通过一个或多个额外的 CSS 样式表来丰富 UI.//该文件必须作为嵌入式资源"包含在您的项目中，然后资源的//逻辑名称"传递给方法，如下所示.////c.InjectStylesheet(包含Assembly, "Swashbuckle.Dummy.SwaggerExtensions.testStyles1.css");//使用 "InjectJavaScript" 选项在 swagger-ui 之后调用一个或多个自定义 JavaScript//已加载.该文件必须作为嵌入式资源"包含在您的项目中，然后是资源的//逻辑名称"被传递给如上所示的方法.////c.InjectJavaScript(thisAssembly, "Swashbuckle.Dummy.SwaggerExtensions.testScript1.js");//swagger-ui 将布尔数据类型呈现为下拉列表.默认情况下，它提供true"和false"//字符串作为可能的选择.您可以使用此选项将这些更改为其他内容，//例如 0 和 1.//c.BooleanValues(new[] { "0", "1" });//默认情况下，swagger-ui 将根据 swagger.io 的在线验证器验证规范并显示结果//在页面底部的徽章中.使用这些选项设置不同的验证器 URL 或禁用//完全特征.//c.SetValidatorUrl("localhost/validator");//c.DisableValidator();//使用此选项控制操作列表的显示方式.//可以设置为无"(默认)、列表"(显示每个资源的操作)、//或完整"(完全展开:显示操作及其详细信息).//c.DocExpansion(DocExpansion.List);//使用 CustomAsset 选项提供您自己在 swagger-ui 中使用的资产版本.//它通常用于指示 Swashbuckle 返回您的版本而不是默认版本//当对index.html"发出请求时.与所有自定义内容一样，必须包含该文件//在您的项目中作为嵌入式资源"，然后将资源的逻辑名称"传递给//方法如下图.////c.CustomAsset("index", containsAssembly, "YourWebApiProject.SwaggerExtensions.index.html");//如果您的 API 有多个版本并且您已应用 MultipleApiVersions 设置//如上所述，您还可以在 swagger-ui 中启用一个选择框，显示//每个版本的发现 URL.这为用户浏览文档提供了一种方便的方式//针对不同的 API 版本.////c.EnableDiscoveryUrlSelector();//如果您的 API 支持 OAuth2 隐式流程，并且您已经正确描述了它，根据//Swagger 2.0 规范，您可以启用 UI 支持，如下所示.//c.EnableOAuth2Support("test-client-id", "test-realm", "Swagger UI");});}私有静态字符串 GetXmlCommentsPath(){return String.Format(@"{0}indoc.xml", AppDomain.CurrentDomain.BaseDirectory);}}公共类 ApplySchemaVendorExtensions : ISchemaFilter{公共无效应用(架构模式，SchemaRegistry schemaRegistry，类型类型){schema.vendorExtensions.Add("x-schema", "bar");}}}

解决方案

如果我没看错，您是在调用 Startup 中的 Configuration 之前调用 Register 方法吗?如果是这种情况，我认为您不必要地使事情复杂化.这是我通常做的:

公共类启动{公共无效配置(IAppBuilder 应用程序){var config = new HttpConfiguration();config.MapHttpAttributeRoutes();//任何附加配置:过滤器、服务等config.EnableSwagger(x => x.SingleApiVersion("v1", "应用程序名称")).EnableSwaggerUi();app.UseWebApi(配置)}}

如果您在全局配置上启用 Swagger，并在新的 HttpConfiguration 实例上启动 Web Api，那么这很可能是您的问题.

希望对您有所帮助.

I have created a WebApi Project using this article.

Things are working fine. But now my client want to view the documentation using Swagger. I tried to do configuration but things are not working. not getting the list of controllers and their action.

below is the swagger config:

using System.Web.Http; using WebActivatorEx; using DC.SUMS.WebAPI1; using Swashbuckle.Application; using System; using System.Linq; using Swashbuckle.Swagger; using Swashbuckle.Dummy.SwaggerExtensions; [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")] namespace DC.SUMS.WebAPI1 { public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuration .EnableSwagger(c => { // By default, the service root url is inferred from the request used to access the docs. // However, there may be situations (e.g. proxy and load-balanced environments) where this does not // resolve correctly. You can workaround this by providing your own code to determine the root URL. // //c.RootUrl(req => GetRootUrlFromAppConfig()); // If schemes are not explicitly provided in a Swagger 2.0 document, then the scheme used to access // the docs is taken as the default. If your API supports multiple schemes and you want to be explicit // about them, you can use the "Schemes" option as shown below. // //c.Schemes(new[] { "http", "https" }); // Use "SingleApiVersion" to describe a single version API. Swagger 2.0 includes an "Info" object to // hold additional metadata for an API. Version and title are required but you can also provide // additional fields by chaining methods off SingleApiVersion. // c.SingleApiVersion("v1", "DC.SUMS.WebAPI1"); // If your API has multiple versions, use "MultipleApiVersions" instead of "SingleApiVersion". // In this case, you must provide a lambda that tells Swashbuckle which actions should be // included in the docs for a given API version. Like "SingleApiVersion", each call to "Version" // returns an "Info" builder so you can provide additional metadata per API version. // //c.MultipleApiVersions( // (apiDesc, targetApiVersion) => ResolveVersionSupportByRouteConstraint(apiDesc, targetApiVersion), // (vc) => // { // vc.Version("v2", "Swashbuckle Dummy API V2"); // vc.Version("v1", "Swashbuckle Dummy API V1"); // }); // You can use "BasicAuth", "ApiKey" or "OAuth2" options to describe security schemes for the API. // See github/swagger-api/swagger-spec/blob/master/versions/2.0.md for more details. // NOTE: These only define the schemes and need to be coupled with a corresponding "security" property // at the document or operation level to indicate which schemes are required for an operation. To do this, // you'll need to implement a custom IDocumentFilter and/or IOperationFilter to set these properties // according to your specific authorization implementation // //c.BasicAuth("basic") // .Description("Basic HTTP Authentication"); // //c.ApiKey("apiKey") // .Description("API Key Authentication") // .Name("apiKey") // .In("header"); // c.OAuth2("oauth2") .Description("OAuth2 Implicit Grant") .Flow("implicit") .AuthorizationUrl("localhost:8891/authorize") .TokenUrl("localhost:8891/token") .Scopes(scopes => { scopes.Add("read", "Read access to protected resources"); scopes.Add("write", "Write access to protected resources"); }); // Set this flag to omit descriptions for any actions decorated with the Obsolete attribute //c.IgnoreObsoleteActions(); // Each operation be assigned one or more tags which are then used by consumers for various reasons. // For example, the swagger-ui groups operations according to the first tag of each operation. // By default, this will be controller name but you can use the "GroupActionsBy" option to // override with any value. // //c.GroupActionsBy(apiDesc => apiDesc.HttpMethod.ToString()); // You can also specify a custom sort order for groups (as defined by "GroupActionsBy") to dictate // the order in which operations are listed. For example, if the default grouping is in place // (controller name) and you specify a descending alphabetic sort order, then actions from a // ProductsController will be listed before those from a CustomersController. This is typically // used to customize the order of groupings in the swagger-ui. // //c.OrderActionGroupsBy(new DescendingAlphabeticComparer()); // If you annotate Controllers and API Types with // Xml comments (msdn.microsoft/en-us/library/b2s063f7(v=vs.110).aspx), you can incorporate // those comments into the generated docs and UI. You can enable this by providing the path to one or // more Xml comment files. // c.IncludeXmlComments(GetXmlCommentsPath()); // Swashbuckle makes a best attempt at generating Swagger compliant JSON schemas for the various types // exposed in your API. However, there may be occasions when more control of the output is needed. // This is supported through the "MapType" and "SchemaFilter" options: // // Use the "MapType" option to override the Schema generation for a specific type. // It should be noted that the resulting Schema will be placed "inline" for any applicable Operations. // While Swagger 2.0 supports inline definitions for "all" Schema types, the swagger-ui tool does not. // It expects "complex" Schemas to be defined separately and referenced. For this reason, you should only // use the "MapType" option when the resulting Schema is a primitive or array type. If you need to alter a // complex Schema, use a Schema filter. // //c.MapType<ProductType>(() => new Schema { type = "integer", format = "int32" }); // If you want to post-modify "complex" Schemas once they've been generated, across the board or for a // specific type, you can wire up one or more Schema filters. // c.SchemaFilter<ApplySchemaVendorExtensions>(); // In a Swagger 2.0 document, complex types are typically declared globally and referenced by unique // Schema Id. By default, Swashbuckle does NOT use the full type name in Schema Ids. In most cases, this // works well because it prevents the "implementation detail" of type namespaces from leaking into your // Swagger docs and UI. However, if you have multiple types in your API with the same class name, you'll // need to opt out of this behavior to avoid Schema Id conflicts. // //c.UseFullTypeNameInSchemaIds(); // Alternatively, you can provide your own custom strategy for inferring SchemaId's for // describing "complex" types in your API. // c.SchemaId(t => t.FullName.Contains('`') ? t.FullName.Substring(0, t.FullName.IndexOf('`')) : t.FullName); // Set this flag to omit schema property descriptions for any type properties decorated with the // Obsolete attribute c.IgnoreObsoleteProperties(); // In accordance with the built in JsonSerializer, Swashbuckle will, by default, describe enums as integers. // You can change the serializer behavior by configuring the StringToEnumConverter globally or for a given // enum type. Swashbuckle will honor this change out-of-the-box. However, if you use a different // approach to serialize enums as strings, you can also force Swashbuckle to describe them as strings. // c.DescribeAllEnumsAsStrings(); // Similar to Schema filters, Swashbuckle also supports Operation and Document filters: // // Post-modify Operation descriptions once they've been generated by wiring up one or more // Operation filters. // c.OperationFilter<AddDefaultResponse>(); // // If you've defined an OAuth2 flow as described above, you could use a custom filter // to inspect some attribute on each action and infer which (if any) OAuth2 scopes are required // to execute the operation // c.OperationFilter<AssignOAuth2SecurityRequirements>(); c.OperationFilter<AddFileUploadParams>(); c.OperationFilter<SupportFlaggedEnums>(); c.OperationFilter<UpdateFileDownloadOperations>(); // Post-modify the entire Swagger document by wiring up one or more Document filters. // This gives full control to modify the final SwaggerDocument. You should have a good understanding of // the Swagger 2.0 spec. - github/swagger-api/swagger-spec/blob/master/versions/2.0.md // before using this option. // c.DocumentFilter<ApplyDocumentVendorExtensions>(); // In contrast to WebApi, Swagger 2.0 does not include the query string component when mapping a URL // to an action. As a result, Swashbuckle will raise an exception if it encounters multiple actions // with the same path (sans query string) and HTTP method. You can workaround this by providing a // custom strategy to pick a winner or merge the descriptions for the purposes of the Swagger docs // c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); // Wrap the default SwaggerGenerator with additional behavior (e.g. caching) or provide an // alternative implementation for ISwaggerProvider with the CustomProvider option. // //c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider)); }) .EnableSwaggerUi(c => { // Use the "InjectStylesheet" option to enrich the UI with one or more additional CSS stylesheets. // The file must be included in your project as an "Embedded Resource", and then the resource's // "Logical Name" is passed to the method as shown below. // //c.InjectStylesheet(containingAssembly, "Swashbuckle.Dummy.SwaggerExtensions.testStyles1.css"); // Use the "InjectJavaScript" option to invoke one or more custom JavaScripts after the swagger-ui // has loaded. The file must be included in your project as an "Embedded Resource", and then the resource's // "Logical Name" is passed to the method as shown above. // //c.InjectJavaScript(thisAssembly, "Swashbuckle.Dummy.SwaggerExtensions.testScript1.js"); // The swagger-ui renders boolean data types as a dropdown. By default, it provides "true" and "false" // strings as the possible choices. You can use this option to change these to something else, // for example 0 and 1. // c.BooleanValues(new[] { "0", "1" }); // By default, swagger-ui will validate specs against swagger.io's online validator and display the result // in a badge at the bottom of the page. Use these options to set a different validator URL or to disable the // feature entirely. //c.SetValidatorUrl("localhost/validator"); //c.DisableValidator(); // Use this option to control how the Operation listing is displayed. // It can be set to "None" (default), "List" (shows operations for each resource), // or "Full" (fully expanded: shows operations and their details). // c.DocExpansion(DocExpansion.List); // Use the CustomAsset option to provide your own version of assets used in the swagger-ui. // It's typically used to instruct Swashbuckle to return your version instead of the default // when a request is made for "index.html". As with all custom content, the file must be included // in your project as an "Embedded Resource", and then the resource's "Logical Name" is passed to // the method as shown below. // //c.CustomAsset("index", containingAssembly, "YourWebApiProject.SwaggerExtensions.index.html"); // If your API has multiple versions and you've applied the MultipleApiVersions setting // as described above, you can also enable a select box in the swagger-ui, that displays // a discovery URL for each version. This provides a convenient way for users to browse documentation // for different API versions. // //c.EnableDiscoveryUrlSelector(); // If your API supports the OAuth2 Implicit flow, and you've described it correctly, according to // the Swagger 2.0 specification, you can enable UI support as shown below. // c.EnableOAuth2Support("test-client-id", "test-realm", "Swagger UI"); }); } private static string GetXmlCommentsPath() { return String.Format(@"{0}indoc.xml", AppDomain.CurrentDomain.BaseDirectory); } } public class ApplySchemaVendorExtensions : ISchemaFilter { public void Apply(Schema schema, SchemaRegistry schemaRegistry, Type type) { schema.vendorExtensions.Add("x-schema", "bar"); } } }

解决方案

If I'm reading this correctly, you are calling the Register method before you are calling Configuration in Startup? If this is the case, I think you are needlessly complicating things. This is what I typically do:

public class Startup { public void Configuration(IAppBuilder app) { var config = new HttpConfiguration(); config.MapHttpAttributeRoutes(); // Any additional configuration: filters, services, etc. config.EnableSwagger(x => x.SingleApiVersion("v1", "Application Name")).EnableSwaggerUi(); app.UseWebApi(config) } }

If you are enabling Swagger on the global configuration, and starting Web Api on a new HttpConfiguration instance, then that is most likely your problem.

Hope that helps.