public void It_should_generate_an_api_spec_for_each_url_in_a_declaration()
{
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
ApiDeclaration(swaggerSpec, "/Orders", dec =>
{
// 2: /api/orders, /api/orders/{id}
Assert.AreEqual(2, dec.Apis.Count);
ApiSpec(dec, "/api/orders", api => Assert.IsNull(api.Description));
ApiSpec(dec, "/api/orders/{id}", api => Assert.IsNull(api.Description));
});
ApiDeclaration(swaggerSpec, "/OrderItems", dec =>
{
// 2: /api/orders/{orderId}/items/{id}, /api/orders/{orderId}/items?category={category}
Assert.AreEqual(2, dec.Apis.Count);
ApiSpec(dec, "/api/orders/{orderId}/items/{id}", api => Assert.IsNull(api.Description));
ApiSpec(dec, "/api/orders/{orderId}/items", api => Assert.IsNull(api.Description));
});
ApiDeclaration(swaggerSpec, "/Customers", dec =>
{
// 2: /api/customers, /api/customers/{id}
Assert.AreEqual(2, dec.Apis.Count);
ApiSpec(dec, "/api/customers", api => Assert.IsNull(api.Description));
ApiSpec(dec, "/api/customers/{id}", api => Assert.IsNull(api.Description));
});
}
public void It_should_apply_all_configured_operation_spec_filters()
{
_config
.PostFilter<AddStandardErrorCodes>()
.PostFilter<AddAuthorizationErrorCodes>();
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
OperationSpec(swaggerSpec, "/Orders", "/api/orders", 0, "POST", operation =>
Assert.AreEqual(2, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/Orders", "/api/orders", 0, "GET", operation =>
Assert.AreEqual(2, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/Orders", "/api/orders", 1, "GET", operation =>
Assert.AreEqual(2, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/Orders", "/api/orders/{id}", 0, "DELETE", operation =>
Assert.AreEqual(2, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/OrderItems", "/api/orders/{orderId}/items/{id}", 0, "GET", operation =>
Assert.AreEqual(2, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/OrderItems", "/api/orders/{orderId}/items", 0, "GET", operation =>
Assert.AreEqual(2, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/Customers", "/api/customers/{id}", 0, "GET", operation =>
Assert.AreEqual(3, operation.ResponseMessages.Count));
OperationSpec(swaggerSpec, "/Customers", "/api/customers/{id}", 0, "DELETE", operation =>
Assert.AreEqual(3, operation.ResponseMessages.Count));
}
static SwaggerGenerator()
{
Instance = new SwaggerGenerator(
SwaggerSpecConfig.Instance.DeclarationKeySelector,
SwaggerSpecConfig.Instance.BasePathResolver,
SwaggerSpecConfig.Instance.OperationSpecFilters,
SwaggerSpecConfig.Instance.CustomTypeMappings);
}
public static SwaggerSpec CreateFrom(IApiExplorer apiExplorer)
{
var swaggerGenerator = new SwaggerGenerator(
SwaggerSpecConfig.Instance.DeclarationKeySelector,
SwaggerSpecConfig.Instance.BasePathResolver,
SwaggerSpecConfig.Instance.CustomTypeMappings,
SwaggerSpecConfig.Instance.OperationFilters,
SwaggerSpecConfig.Instance.OperationSpecFilters);
// TODO: Implement as Singleton - there is only one spec and it should only be generated once
return swaggerGenerator.From(apiExplorer);
}
public SwaggerSpec SwaggerSpec()
{
lock (SyncRoot)
{
if (_swaggerSpec == null)
{
var swaggerGenerator = new SwaggerGenerator();
var apiExplorer = GlobalConfiguration.Configuration.Services.GetApiExplorer();
_swaggerSpec = swaggerGenerator.ApiExplorerToSwaggerSpec(apiExplorer);
}
}
return _swaggerSpec;
}
public void It_should_generate_an_operation_spec_for_all_supported_methods_on_a_url()
{
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
ApiSpec(swaggerSpec, "/Orders", "/api/orders", api =>
{
// 4: POST /api/orders, GET /api/orders, GET /api/orders?foo={foo}&bar={bar}, DELETE /api/orders
Assert.AreEqual(4, api.Operations.Count);
OperationSpec(api, "POST", 0, operation =>
{
Assert.AreEqual("Orders_Post", operation.Nickname);
Assert.AreEqual("Documentation for 'Post'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("Order", operation.Type);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Enum);
});
OperationSpec(api, "GET", 0, operation =>
{
Assert.AreEqual("Orders_GetAll", operation.Nickname);
Assert.AreEqual("Documentation for 'GetAll'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("array", operation.Type);
Assert.AreEqual("Order", operation.Items.Ref);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Enum);
});
OperationSpec(api, "GET", 1, operation =>
{
Assert.AreEqual("Orders_GetByParams", operation.Nickname);
Assert.AreEqual("Documentation for 'GetByParams'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("array", operation.Type);
Assert.AreEqual("Order", operation.Items.Ref);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Enum);
});
OperationSpec(api, "DELETE", 0, operation =>
{
Assert.AreEqual("Orders_DeleteAll", operation.Nickname);
Assert.AreEqual("Documentation for 'DeleteAll'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("void", operation.Type);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Enum);
});
});
ApiSpec(swaggerSpec, "/Orders", "/api/orders/{id}", api =>
{
// 1: DELETE /api/orders/{id}
Assert.AreEqual(1, api.Operations.Count);
OperationSpec(api, "DELETE", 0, operation =>
{
Assert.AreEqual("Orders_Delete", operation.Nickname);
Assert.AreEqual("Documentation for 'Delete'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("void", operation.Type);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Enum);
});
});
ApiSpec(swaggerSpec, "/OrderItems", "/api/orders/{orderId}/items/{id}", api =>
{
// 1: GET /api/orders/{orderId}/items/{id}
Assert.AreEqual(1, api.Operations.Count);
OperationSpec(api, "GET", 0, operation =>
{
Assert.AreEqual("OrderItems_GetById", operation.Nickname);
Assert.AreEqual("Documentation for 'GetById'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("OrderItem", operation.Type);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Enum);
});
});
ApiSpec(swaggerSpec, "/OrderItems", "/api/orders/{orderId}/items", api =>
{
// 1: GET /api/orders/{orderId}/items?category={category}
Assert.AreEqual(1, api.Operations.Count);
OperationSpec(api, "GET", 0, operation =>
{
Assert.AreEqual("OrderItems_GetAll", operation.Nickname);
Assert.AreEqual("Documentation for 'GetAll'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("array", operation.Type);
Assert.AreEqual("OrderItem", operation.Items.Ref);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Enum);
});
});
ApiSpec(swaggerSpec, "/Customers", "/api/customers", api =>
{
// 1: POST /api/customers
Assert.AreEqual(1, api.Operations.Count);
OperationSpec(api, "POST", 0, operation =>
{
Assert.AreEqual("Customers_Post", operation.Nickname);
Assert.AreEqual("Documentation for 'Post'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("Object", operation.Type);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Enum);
});
});
ApiSpec(swaggerSpec, "/Customers", "/api/customers/{id}", api =>
{
// 1: GET /api/customers/{id}, DELETE /api/customers/{id}
Assert.AreEqual(2, api.Operations.Count);
OperationSpec(api, "GET", 0, operation =>
{
Assert.AreEqual("Customers_Get", operation.Nickname);
Assert.AreEqual("Documentation for 'Get'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("Customer", operation.Type);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Enum);
});
OperationSpec(api, "DELETE", 0, operation =>
{
Assert.AreEqual("Customers_Delete", operation.Nickname);
Assert.AreEqual("Documentation for 'Delete'.", operation.Summary);
Assert.IsNull(operation.Notes);
Assert.AreEqual("Object", operation.Type);
Assert.IsNull(operation.Format);
Assert.IsNull(operation.Items);
Assert.IsNull(operation.Enum);
});
});
}
public void It_should_honor_the_config_setting_to_ignore_obsolete_actions()
{
_config.IgnoreObsoleteActions = true;
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
ApiSpec(swaggerSpec, "/Orders", "/api/orders", api => CollectionAssert.IsEmpty(api.Operations.Where(op => op.Nickname == "Orders_DeleteAll")));
}
public void It_should_generate_model_specs_for_explicitly_configured_sub_types()
{
_config.SubTypesOf<Product>()
.Include<Book>()
.Include<Album>()
.Include<Service>();
_config.SubTypesOf<Service>()
.Include<Shipping>()
.Include<Packaging>();
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
ApiDeclaration(swaggerSpec, "/Products", dec =>
{
Assert.AreEqual(6, dec.Models.Count);
Model(dec, "Product", model =>
{
ModelProperty(model, "Id", property =>
{
Assert.AreEqual("integer", property.Type);
Assert.AreEqual("int32", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Price", property =>
{
Assert.AreEqual("number", property.Type);
Assert.AreEqual("double", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
CollectionAssert.AreEqual(new[] { "Book", "Album", "Service" }, model.SubTypes);
});
Model(dec, "Book", model =>
{
ModelProperty(model, "Title", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Author", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
CollectionAssert.IsEmpty(model.SubTypes);
});
Model(dec, "Album", model =>
{
ModelProperty(model, "Name", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Artist", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
CollectionAssert.IsEmpty(model.SubTypes);
});
Model(dec, "Service", model =>
{
CollectionAssert.IsEmpty(model.Properties);
CollectionAssert.AreEqual(new[] { "Shipping", "Packaging" }, model.SubTypes);
});
Model(dec, "Shipping", model =>
{
CollectionAssert.IsEmpty(model.Properties);
CollectionAssert.IsEmpty(model.SubTypes);
});
Model(dec, "Packaging", model =>
{
CollectionAssert.IsEmpty(model.Properties);
CollectionAssert.IsEmpty(model.SubTypes);
});
});
}
public void It_should_generate_model_specs_for_complex_types_in_a_declaration()
{
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
ApiDeclaration(swaggerSpec, "/Orders", dec =>
{
// 1: Order
Assert.AreEqual(3, dec.Models.Count);
Model(dec, "Order", model =>
{
CollectionAssert.AreEqual(new[] { "Id", "Total" }, model.Required);
ModelProperty(model, "Id", property =>
{
Assert.AreEqual("integer", property.Type);
Assert.AreEqual("int32", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Description", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Total", property =>
{
Assert.AreEqual("number", property.Type);
Assert.AreEqual("double", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
});
Model(dec, "MyGenericType[OrderItem]", model =>
{
CollectionAssert.IsEmpty(model.Required);
ModelProperty(model, "TypeName", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
});
Model(dec, "MyGenericType[ProductCategory]", model =>
{
CollectionAssert.IsEmpty(model.Required);
ModelProperty(model, "TypeName", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
});
});
ApiDeclaration(swaggerSpec, "/OrderItems", dec =>
{
// 1: OrderItem
Assert.AreEqual(1, dec.Models.Count);
Model(dec, "OrderItem", model =>
{
CollectionAssert.AreEqual(new[] { "LineNo", "Product" }, model.Required);
ModelProperty(model, "LineNo", property =>
{
Assert.AreEqual("integer", property.Type);
Assert.AreEqual("int32", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Product", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Category", property =>
{
Assert.AreEqual("string", property.Type);
Assert.IsNotNull(property.Enum);
Assert.IsTrue(property.Enum.SequenceEqual(new[] { "Category1", "Category2", "Category3" }));
Assert.IsNull(property.Format);
Assert.IsNull(property.Items);
});
ModelProperty(model, "Quantity", property =>
{
Assert.AreEqual("integer", property.Type);
Assert.AreEqual("int32", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
});
});
ApiDeclaration(swaggerSpec, "/Customers", dec =>
{
Assert.AreEqual(2, dec.Models.Count);
Model(dec, "Object", model => CollectionAssert.IsEmpty(model.Required));
Model(dec, "Customer", model =>
{
CollectionAssert.IsEmpty(model.Required);
ModelProperty(model, "Id", property =>
{
Assert.AreEqual("integer", property.Type);
Assert.AreEqual("int32", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Associates", property =>
{
Assert.AreEqual("array", property.Type);
Assert.AreEqual("Customer", property.Items.Ref);
Assert.IsNull(property.Format);
Assert.IsNull(property.Enum);
});
});
});
ApiDeclaration(swaggerSpec, "/Products", dec =>
{
Assert.AreEqual(1, dec.Models.Count);
Model(dec, "Product", model =>
{
ModelProperty(model, "Id", property =>
{
Assert.AreEqual("integer", property.Type);
Assert.AreEqual("int32", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
ModelProperty(model, "Price", property =>
{
Assert.AreEqual("number", property.Type);
Assert.AreEqual("double", property.Format);
Assert.IsNull(property.Items);
Assert.IsNull(property.Enum);
});
CollectionAssert.IsEmpty(model.SubTypes);
});
});
}
public void It_should_generate_declarations_according_to_provided_strategy()
{
_config.GroupDeclarationsBy(apiDesc => apiDesc.ActionDescriptor.ControllerDescriptor.ControllerName);
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
ApiDeclaration(swaggerSpec, "/Orders", dec =>
{
Assert.AreEqual("1.2", dec.SwaggerVersion);
Assert.AreEqual("http://tempuri.org", dec.BasePath);
Assert.AreEqual("/Orders", dec.ResourcePath);
});
ApiDeclaration(swaggerSpec, "/OrderItems", dec =>
{
Assert.AreEqual("1.2", dec.SwaggerVersion);
Assert.AreEqual("http://tempuri.org", dec.BasePath);
Assert.AreEqual("/OrderItems", dec.ResourcePath);
});
ApiDeclaration(swaggerSpec, "/Customers", dec =>
{
Assert.AreEqual("1.2", dec.SwaggerVersion);
Assert.AreEqual("http://tempuri.org", dec.BasePath);
Assert.AreEqual("/Customers", dec.ResourcePath);
});
}
public void It_should_generate_a_parameter_spec_for_each_parameter_in_a_given_operation()
{
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
OperationSpec(swaggerSpec, "/Orders", "/api/orders", 0, "POST", operation =>
{
Assert.AreEqual(1, operation.Parameters.Count);
ParameterSpec(operation, "order", parameter =>
{
Assert.AreEqual("body", parameter.ParamType);
Assert.AreEqual("Documentation for 'order'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("Order", parameter.Type);
Assert.IsNull(parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
OperationSpec(swaggerSpec, "/Orders", "/api/orders", 0, "GET", operation =>
Assert.AreEqual(0, operation.Parameters.Count));
OperationSpec(swaggerSpec, "/Orders", "/api/orders", 1, "GET", operation =>
{
Assert.AreEqual(2, operation.Parameters.Count);
ParameterSpec(operation, "foo", parameter =>
{
Assert.AreEqual("query", parameter.ParamType);
Assert.AreEqual("Documentation for 'foo'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("string", parameter.Type);
Assert.IsNull(parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
ParameterSpec(operation, "bar", parameter =>
{
Assert.AreEqual("query", parameter.ParamType);
Assert.AreEqual("Documentation for 'bar'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("string", parameter.Type);
Assert.IsNull(parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
OperationSpec(swaggerSpec, "/Orders", "/api/orders/{id}", 0, "DELETE", operation =>
{
Assert.AreEqual(1, operation.Parameters.Count);
ParameterSpec(operation, "id", parameter =>
{
Assert.AreEqual("path", parameter.ParamType);
Assert.AreEqual("Documentation for 'id'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("integer", parameter.Type);
Assert.AreEqual("int32", parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
OperationSpec(swaggerSpec, "/OrderItems", "/api/orders/{orderId}/items/{id}", 0, "GET", operation =>
{
Assert.AreEqual(2, operation.Parameters.Count);
ParameterSpec(operation, "orderId", parameter =>
{
Assert.AreEqual("path", parameter.ParamType);
Assert.AreEqual("Documentation for 'orderId'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("integer", parameter.Type);
Assert.AreEqual("int32", parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
ParameterSpec(operation, "id", parameter =>
{
Assert.AreEqual("path", parameter.ParamType);
Assert.AreEqual("Documentation for 'id'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("integer", parameter.Type);
Assert.AreEqual("int32", parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
OperationSpec(swaggerSpec, "/OrderItems", "/api/orders/{orderId}/items", 0, "GET", operation =>
{
Assert.AreEqual(2, operation.Parameters.Count);
ParameterSpec(operation, "orderId", parameter =>
{
Assert.AreEqual("path", parameter.ParamType);
Assert.AreEqual("Documentation for 'orderId'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("integer", parameter.Type);
Assert.AreEqual("int32", parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
ParameterSpec(operation, "category", parameter =>
{
Assert.AreEqual("query", parameter.ParamType);
Assert.AreEqual("Documentation for 'category'.", parameter.Description);
Assert.AreEqual(false, parameter.Required);
Assert.AreEqual("string", parameter.Type);
Assert.IsNotNull(parameter.Enum);
Assert.IsTrue(parameter.Enum.SequenceEqual(new[] { "Category1", "Category2", "Category3" }));
Assert.IsNull(parameter.Format);
Assert.IsNull(parameter.Items);
});
});
OperationSpec(swaggerSpec, "/Customers", "/api/customers", 0, "POST", operation =>
{
Assert.AreEqual(1, operation.Parameters.Count);
ParameterSpec(operation, "customer", parameter =>
{
Assert.AreEqual("body", parameter.ParamType);
Assert.AreEqual("Documentation for 'customer'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("Object", parameter.Type);
Assert.IsNull(parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
OperationSpec(swaggerSpec, "/Customers", "/api/customers/{id}", 0, "GET", operation =>
{
Assert.AreEqual(1, operation.Parameters.Count);
ParameterSpec(operation, "id", parameter =>
{
Assert.AreEqual("path", parameter.ParamType);
Assert.AreEqual("Documentation for 'id'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("integer", parameter.Type);
Assert.AreEqual("int32", parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
OperationSpec(swaggerSpec, "/Customers", "/api/customers/{id}", 0, "DELETE", operation =>
{
Assert.AreEqual(1, operation.Parameters.Count);
ParameterSpec(operation, "id", parameter =>
{
Assert.AreEqual("path", parameter.ParamType);
Assert.AreEqual("Documentation for 'id'.", parameter.Description);
Assert.AreEqual(true, parameter.Required);
Assert.AreEqual("integer", parameter.Type);
Assert.AreEqual("int32", parameter.Format);
Assert.IsNull(parameter.Items);
Assert.IsNull(parameter.Enum);
});
});
}
public void It_should_generate_a_listing_according_to_provided_strategy()
{
_config.GroupDeclarationsBy(apiDesc => apiDesc.ActionDescriptor.ControllerDescriptor.ControllerName);
var swaggerSpec = new SwaggerGenerator(_config).ApiExplorerToSwaggerSpec(_apiExplorer);
// e.g. Uses ControllerName by default
var resourceListing = swaggerSpec.Listing;
Assert.AreEqual("1.0", resourceListing.ApiVersion);
Assert.AreEqual("1.2", resourceListing.SwaggerVersion);
Assert.AreEqual(4, resourceListing.Apis.Count());
Assert.IsTrue(resourceListing.Apis.Any(a => a.Path == "/Orders"),
"Orders declaration not listed");
Assert.IsTrue(resourceListing.Apis.Any(a => a.Path == "/OrderItems"),
"OrderItems declaration not listed");
Assert.IsTrue(resourceListing.Apis.Any(a => a.Path == "/Customers"),
"Customers declaration not listed");
Assert.IsTrue(resourceListing.Apis.Any(a => a.Path == "/Products"),
"Products declaration not listed");
}
