Step1.创建.NetCore项目(VS2019)
Step2:
下载安装NuGet包
Swashbuckle.AspNetCore
*Step3
打开Startup类
在ConfigureServices方法里面注册服务
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddControllersWithViews();
services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo
{
Version = "v1",
Title = "swagger测试项目",
Description = "TmsBackgroundWebAPI"
});
});
}
接着在Configure方法里面添加中间件
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseRouting();
app.UseAuthorization();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json","xdmAPIV1");
});
app.UseEndpoints(endpoints =>
{
endpoints.MapGet("/", async context =>
{
await context.Response.WriteAsync("Hello World!");
});
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
});
}
Step4
右键项目属性
输出xml文档文件
最后在项目里面新建一个目录Controllers文件夹,在文件夹里面新建控制器
然后在控制器里面添加一个方法
[Route("api/[controller]/[action]")]
[ApiController]
public class HomeController : Controller
{
[HttpGet]
public string get()
{
return "ok";
}
}
最终效果:
ending
写在最后:现在网站开发基本上都是用的前后端分离模式,使得前后端只用专注于自己擅长的工作,各司其职,有利于提高开发者效率。Swagger相比于以前的Word接口文档的形式,好处在于,前端不用担心接口文档与实际接口不符合,又省去了后端编写和维护接口文档的时间问题