Web Api 2 接口API文档美化

使用用第三方提供的swgger ui 帮助提高 web api 接口列表的阅读性，并且可以在页面中测试服务接口。

运行程序如下：

注意：在IE中必须输入红色部分。

并且可以对方法进行测试。

在开发web api 是可以写清楚注释，并且在文档中可以全部的显示出来。

在工程中处了安装Swashbuckle 以外，还会用到Owin,system.web.http.owin库

在WebApi项目工程中安装:Install-Package Swashbuckle ，安装成功能后，会在项目中的App_Start文件

夹中生成一个文件名为“SwaggerConfig”的文件。并修改如下：

   1:  using System.Web.Http;

   2:  using WebApi;

   3:  using WebActivatorEx;

   4:  using Swashbuckle.Application;

   5:   

   6:  [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

   7:   

   8:  namespace WebApi

   9:  {

  10:      public class SwaggerConfig

  11:      {

  12:          public static void Register()

  13:          {

  14:              Swashbuckle.Bootstrapper.Init(GlobalConfiguration.Configuration);

  15:   

  16:              // NOTE: If you want to customize the generated swagger or UI, use SwaggerSpecConfig and/or SwaggerUiConfig here ...

  17:              SwaggerSpecConfig.Customize(c =>

  18:              {

  19:                  c.IncludeXmlComments(GetXmlCommentsPath());

  20:              });

  21:          }

  22:   

  23:          private static string GetXmlCommentsPath()

  24:          {

  25:              return System.String.Format(@"{0}\bin\WebApi.XML", System.AppDomain.CurrentDomain.BaseDirectory);

  26:          }

  27:      }

  28:  }

在工程中添加一个StartUp的文件，代码如下：

   1:   

   2:  using Microsoft.Owin;

   3:  using Owin;

   4:  using System;

   5:  using System.Collections.Generic;

   6:  using System.Linq;

   7:  using System.Web;

   8:  using System.Web.Http;

   9:   

  10:  [assembly: OwinStartup(typeof(WebApi.Startup))]

  11:  namespace WebApi

  12:  {

  13:      public class Startup

  14:      {

  15:          public void Configuration(IAppBuilder app)

  16:          {

  17:              HttpConfiguration config = new HttpConfiguration();

  18:              WebApiConfig.Register(config);

  19:              Swashbuckle.Bootstrapper.Init(config);

  20:              app.UseWebApi(config);

  21:          }

  22:      }

  23:  }

新建一个studentController:

namespace WebApi.Controllers
{
    /// <summary>
    /// 用户接口
    /// </summary>
    public class StudentController : ApiController
    {
        /// <summary>
        /// 得到所有的学生信息
        /// </summary>
        /// <returns></returns>
        public IEnumerable<StudentModel> Get()
        {
            return new List<StudentModel>();
        }

        /// <summary>
        /// 根据学生编号得到学生信息
        /// </summary>
        /// <param name="Id">学生编号</param>
        /// <returns></returns>
        public StudentModel Get(int Id)
        {
            return new StudentModel { };
        }

        /// <summary>
        /// 添加学生
        /// </summary>
        /// <param name="studentModel">学生实体</param>
        /// <remarks>添加一个新的学生</remarks>
        /// <response code="400">Bad request </response>
        /// <response code="500">Internal Server Error</response>
        public void Post(StudentModel studentModel)
        {
        }


        /// <summary>
        /// 修改学生信息
        /// </summary>
        /// <param name="Id">学生编号</param>
        /// <param name="studentModel">学生实体</param>

        [ResponseType(typeof(StudentModel))]
        [ActionName("UpdateStudentById")]
        public void Put(int Id, [Form]string studentModel)
        {

        }

        /// <summary>
        /// 删除学生信息
        /// </summary>
        /// <param name="Id">学生编号</param>
        public void Delete(int Id)
        {
        }

        /// <summary>
        /// 根据学生姓名得到学生信息
        /// </summary>
        /// <param name="name">学生姓名</param>
        /// <remarks>dfsafdsa</remarks>
        /// <returns></returns>
        //[Route(Name = "GetStudentByUserName")]
        //[ResponseType(typeof(StudentModel))]
        [HttpGet]
        [ActionName("GetStudentByUserName")]
        public IEnumerable<StudentModel> GetStudentByName(string name)
        {
            return new List<StudentModel>();
        }
    }
}

   设置工程属性，在属性的构建中设置输出文档：

这里的“bin\WebApi.XML”文件名称和SwaggerConfig文件中的配置保持一样。