public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2); services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new Info { Title = "晓晨学生管理系统 WebApi", Version = "v1" }); options.DocInclusionPredicate((docName, description) => true); options.IncludeXmlComments(@"bin\Debug\netcoreapp2.2\Xc.StuMgr.WebApiHost.xml"); options.IncludeXmlComments(@"bin\Debug\netcoreapp2.2\Xc.StuMgr.Application.xml"); }); } public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "晓晨学生管理系统 WebApi"); }); app.UseMvc(); }
运行则会直接看到默认的 ValuesController 的5个API。
2.动态WebApi
通过Nuget 为 Application 项目安装组件：
Install-Package Panda.DynamicWebApi
为接口 IApplicationService继承 IDynamicWebApi同时添加特性DynamicWebApi
[DynamicWebApi] public interface IApplicationService:IDynamicWebApi { }
在 WebApi Host 项目中，Startup里配置动态WebApi：
Startup.cs:
// 添加动态WebApi 需放在 AddMvc 之后 services.AddDynamicWebApi();
然后打开浏览器访问将会看到：
可以看到成功为我们的 StudentAppService 生成了WebApi，并且和Swagger完美兼容。
四.详细介绍
经过上面的介绍，大家应该可以看出使用是非常简单的，只需两步：
第一步：为你的类（或者该类的接口、该类继承的抽象类，不得放在该类除前面两种情况的父类上）继承 IDynamicWebApi接口并加入特性[DynamicWebApi]
第二步：Startup中注册
// 添加动态WebApi 需放在 AddMvc 之后 services.AddDynamicWebApi();
因为需要MVC的一些类来进行处理，所以必须放在AddMvc之后，本组件有检查。
1.规则
本组件采用约定大于配置，所以在实际使用中有几个规则：
（1）要让类生成动态API需要满足两个条件，一个是该类直接或间接实现 IDynamicWebApi，同时该类本身或者父抽象类或者实现的接口具有特性 DynamicWebApi
（2）添加特性 [NonDynamicWebApi] 可使一个类或者一个方法不生成API，[NonDynamicWebApi] 具有最高的优先级。
（3）会对符合规则的动态API类名进行后缀的删除，如：我们前面的 StudentAppService，会被删除 AppService 后缀，这个规则是可以动态配置的。
（4）会自动添加API路由前缀，默认会为所有API添加 api前缀
（5）默认的HTTP动词为POST，可以通过 HttpGet/HttpPost/HttpDelete 等等ASP.NET Core 内置特性来覆盖
（6）可以通过HttpGet/HttpPost/HttpDelete 等内置特性来覆盖默认路由
（7）默认会根据你的方法名字来设置HTTP动词，如 CreateApple 或者 Create 生成的API动词为 POST，对照表如下，若命中（忽略大小写）对照表那么该API的名称中的这个动词将会被省略，如 CreateApple 将会变成 Apple，如未在以下对照表中，将会使用默认动词 POST
方法名开头
动词
create
POST
add
POST
post
POST
get
GET
find
GET
fetch
GET
query
GET
update
PUT
put
PUT
delete
DELETE
remove
DELETE
（8）强烈建议方法名称使用帕斯卡命名（PascalCase）规范，以更好的自动处理API名称，且使用以上对照表的动词。如:
添加苹果 -> Add/AddApple/Create/CreateApple
更新苹果 -> Update/UpdateApple
...
（9）[DynamicWebApi] 特性因为可被继承，所以为了父类被误识别，禁止放在除抽象类、接口以外的父类上。
2.配置
所有的配置均在对象 DynamicWebApiOptions 中，说明如下：
属性名
是否必须
说明
DefaultHttpVerb
否
默认值：POST。默认HTTP动词
DefaultAreaName
否
默认值：空。Area 路由名称
DefaultApiPrefix
否
默认值：api。API路由前缀
RemoveControllerPostfixes
否
默认值：AppService/ApplicationService。类名需要移除的后缀
RemoveActionPostfixes
否
默认值：Async。方法名需要移除的后缀
FormBodyBindingIgnoredTypes
否
默认值：IFormFile。不通过MVC绑定到参数列表的类型。
五.疑难解答
若遇到问题，可使用 Issues 进行提问。
六.结束
本项目开源地址：https://github.com/dotnetauth/Panda.DynamicWebApi 希望给个 Star 支持一下
本文Demo地址：XiaoChen.StudentManagement