我使用WebApi已经有几年了,但现在似乎不起作用。在最近的 asp.net .NET Framework 项目中,我已将 WebApi 添加到现有的 MVC 解决方案中。我正在使用 nuget 包 Microsoft.AspNet.WebApi.Versioning 3.0.1
应用程序配置如下:
全球.asax
protected void Application_Start()
{
AreaRegistration.RegisterAllAreas();
GlobalConfiguration.Configure(WebApiConfig.Register);
FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
RouteConfig.RegisterRoutes(RouteTable.Routes);
BundleConfig.RegisterBundles(BundleTable.Bundles);
}
WebApiConfig.cs
public static void Register(HttpConfiguration config)
{
var constraintResolver = new DefaultInlineConstraintResolver()
{
ConstraintMap =
{
["apiVersion"] = typeof( ApiVersionRouteConstraint )
}
};
config.MapHttpAttributeRoutes(constraintResolver);
config.AddApiVersioning();
//config.MapHttpAttributeRoutes(); //commented due to route versioning
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "api/{version}/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
}
API 控制器位于文件夹 /Controller/v1/MyControllerAPI.cs 中
MyControllerAPI.cs
namespace MyProject.Controllers
{
[AllowAnonymous]
[ApiVersion("1")]
[RoutePrefix("api/v{version:apiVersion}/MyControllerAPI")]
public class MyControllerAPI : ApiController
{
private ApplicationDbContext db = new ApplicationDbContext();
[HttpGet]
[Route("GetMonthly")]
public IQueryable<Monthly> GetMonthly()
{
return db.Monthly;
}
}
}
使用 Postman 调用 GET api:https://localhost:44377/api/v1/MyControllerAPI/GetMonthly
它返回此错误:
{
"Error": {
"Code": "ApiVersionUnspecified",
"Message": "An API version is required, but was not specified."
}
}
我的配置有什么问题?我确信过去使用过类似的配置并且它有效。
我有像这样的双 HomeController ;
[Authorize]
[ApiVersion("1.0")]
public class HomeController : BaseApiController
{
private ILogger _logger;
public HomeController(ILogger logger) : base(logger)
{
this._logger = logger;
}
// GET api/<controller>
public IEnumerable<string> Get()
{
return new string[] { "value1", "value2" };
}
// GET api/<controller>/5
public string Get(int id)
{
return "value";
}
// POST api/<controller>
public void Post([FromBody]string value)
{
}
// PUT api/<controller>/5
public void Put(int id, [FromBody]string value)
{
}
// DELETE api/<controller>/5
public void Delete(int id)
{
}
}
2.0 版也一样;
[Authorize]
[ApiVersion("2.0")]
public class HomeController : BaseApiController
{
private ILogger _logger;
public HomeController(ILogger logger) : base(logger)
{
this._logger = logger;
}
public IEnumerable<string> Get()
{
return new string[] { "value2.0", "value3.0" };
}
// GET api/<controller>/5
public string Get(int id)
{
return "value";
}
// POST api/<controller>
public void Post([FromBody]string value)
{
}
// PUT api/<controller>/5
public void Put(int id, [FromBody]string value)
{
}
// DELETE api/<controller>/5
public void Delete(int id)
{
}
}
我使用 Swashbuckle 并添加一些 IOperationFilter 来更改参数或版本控制参数的默认值设置为 apiVersion ;
public class SwaggerAuthTokenHeaderParameter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
operation.deprecated |= apiDescription.IsDeprecated();
if (operation.parameters == null)
{
return;
}
if (operation.parameters != null)
{
foreach (var parameter in operation.parameters)
{
var description = apiDescription.ParameterDescriptions.First(p => p.Name == parameter.name);
if (parameter.description == null)
{
parameter.description = description.Documentation;
}
if (parameter.@default == null)
{
parameter.@default = description.ParameterDescriptor?.DefaultValue;
}
}
operation.parameters.Add(new Parameter
{
name = "Authorization",
@in = "header",
@default = "Bearer ",
description = "Access token for the API",
required = false,
type = "string"
});
}
}
}
或者您可以查看我的 github 存储库以获取 ApiVersioning 和更多功能:) API 仓库