上一篇讲了VsCode的简单介绍,本次主要讲一下VsCode如何创建WebApi项目,及Swagger在线接口文档的使用.
一.创建WebApi项目.
首先打开VsCode 终端控制台,并将工作区指向自己的项目文件夹(手动创建项目文件夹),可输入"cd 项目文件路径"自动进行修改.
指向自已的项目文件夹后,在终端控制台中,输入"dotnet new webapi"即可创建一个空的WebApi项目模板.
如下图,是已经创建成功了的,可以看到,里面已有一个示例控制器了.
创建成功后,该接口是可以直接在浏览器正常访问的了,为了方便查看,下一步,开始创建Swagger在线接口.
二.集成Swagger在线接口文档.
1.首先Swagger程序集引用.在终端控制台输入"dotnet add package Swashbuckle.AspNetCore"即可自动添加程序到项目中.如需指定版本,可在后面追加 " -v 2.0.1"(版本号).
2.打开项目中的Startup.cs文件.
找到ConfigureServices方法,添加Swagger服务并配置文档信息.
public void ConfigureServices (IServiceCollection services) { // 注册Swagger服务 services.AddSwaggerGen (c => { // 添加文档信息 c.SwaggerDoc ("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "WebApiDemo", Version = "v1" }); }); services.AddControllers (); }
找到Configure方法,启用中间件为生成的 JSON 文档和 Swagger UI 提供服务
public void Configure (IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment ()) { app.UseDeveloperExceptionPage (); } app.UseHttpsRedirection (); // 启用Swagger中间件 app.UseSwagger (); // 配置SwaggerUI app.UseSwaggerUI (c => { c.SwaggerEndpoint ("/swagger/v1/swagger.json", "WebApiDemo"); c.RoutePrefix = string.Empty; }); app.UseRouting (); app.UseAuthorization (); app.UseEndpoints (endpoints => { endpoints.MapControllers (); }); }
添加成功后,在终端控制台中,输入dotnet run启动程序,就可以正常在浏览器看到在线的Swagger接口了.