时间 2020-04-16
本文基于朝夕教育--Richard老师的课程学习制作
Begin
关于Controller,首先,右键Controller项目--添加---控制器--选择api控制器(空)--确定,生成一个没有任何API的Controller。注:controller名称必须以Controller结尾,新建一个FirstController。
Controller的使用最好符合RestFul架构风格,可以理解为一个Controller对应一个资源,可以通过访问相应的这些资源获取到所需的数据.
Nuget添加Swagger(读取Controller的相应接口,生成API文档)
Swashbuckle.AspNetCore.Swagger
Swashbuckle.AspNetCore.SwaggerGen
Swashbuckle.AspNetCore.SwaggerUI
下载完毕后在Startup.cs注册Swagger服务
publicvoidConfigureServices(IServiceCollectionservices) {
services.AddControllers();
services.AddSwaggerGen(setUp=>{
#region注册Swagger服 务
setUp.SwaggerDoc("v1",newMicrosoft.OpenApi.Models.OpenApiInfo() {
Title="小马的Swagger",
Version="Version-01",
Description="小马的WebAPI学习"
} );
#endregion
});
}
使用swagger中间件
publicvoidConfigure(IApplicationBuilderapp,IWebHostEnvironmentenv) {
app.UseSwagger(); //告知Core要使用swagger了
//展示页面
app.UseSwaggerUI(s=>{
s.SwaggerEndpoint("/swagger/v1/swagger.json","MySwagger");//v1和注册服务时的取名要一致
});
}
在地址栏输入https://localhost:44380/swagger/index.html