首页 > Windows开发 > 详细

WebApi说明文档插件

时间:2016-03-09 19:08:06      阅读:494      评论:0      收藏:0      [点我收藏+]

1、  NuGet中搜索 Swashbuckle

2、  安装Swashbuckle

3、  Swashbuckle 是通过生成的XML文件来读取注释的,生成 SwaggerUIJSON 配置中的说明的,安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件,用于配置 SwaggerUI 相关展示行为的。如图:

技术分享

将配置文件第99,注释去掉,并修改为:

c.IncludeXmlComments(string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory,thisAssembly.GetName().Name));

 

4、  紧接着你在此Web项目属性选型,生成选卡中选择XML 文档文件”

技术分享

5、  随便创建个webApi文件添加注释

using System;

usingSystem.Collections.Generic;

using System.Linq;

using System.Net;

usingSystem.Net.Http;

usingSystem.Web.Http;

usingClassLibrary1;

 

namespace WebApplication1.Controllers

{

    [Authorize]

publicclass ValuesController :ApiController

    {

//some code.....


/// <summary>

        /// 根据ID获取一个值

        /// </summary>

        /// <param name="id">值的ID</param>

        /// <remarks>当前方法根据ID获取一个值</remarks>

        /// <returns>返回</returns>

public string Get(int id)

        {

            return "value";

        }


// some code ....

    }

}

 

6、  好了接下来F5 运行程序,

地址:http://localhost:50445/swagger/ui/index

就可以看到你所有wabapi的接口以及注释了!还可以调试接口

技术分享


本文出自 “Bruce-Zhang” 博客,请务必保留此出处http://brucezhang51.blog.51cto.com/6252580/1749216

WebApi说明文档插件

原文:http://brucezhang51.blog.51cto.com/6252580/1749216

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!