webapi项目源码

㈠ 怎样操作WebAPI接口

先定义一个简单的webapi，简单到差不多直接用vs2010自动生成的webapi代码。
其中的TestModle是一个简单的class，如下
public class TestModle
{
public string a { get; set; }
public string b { get; set; }
public string c { get; set; }
}

前端页面放四个代表get，post，put，delete的按钮，在加一个div显示返回值

前端代码中加载jquery，在定义四个按钮的click事件

get和post，我习惯用$.get和$.post，当然也能用$.ajax.
get直接返回webapi get的return值，post的话我就不在后端做处理了直接返回传入的值，这里只做示范

put和delete，只能用$.ajax来处理。
put的话一般用于update某个id的数据信息

delete用于删除某个id的数据，如下图所示

点击每个按钮，可以在页面上看到相应的效果
本回答由提问者推荐
评论
1 1

xzozxzb | 汽车顾问向TA咨询
擅长： 汽车
其他回答

先定义一个简单的webapi，简单到差不多直接用vs2010自动生成的webapi代码。
其中的TestModle是一个简单的class，如下
public class TestModle
{
public string a { get; set; }
public string b { get; set; }
public string c { get; set; }
}

前端页面放四个代表get，post，put，delete的按钮，在加一个div显示返回值

前端代码中加载jquery，在定义四个按钮的click事件

get和post，我习惯用$.get和$.post，当然也能用$.ajax.
get直接返回webapi get的return值，post的话我就不在后端做处理了直接返回传入的值，这里只做示范

put和delete，只能用$.ajax来处理。
put的话一般用于update某个id的数据信息

delete用于删除某个id的数据，如下图所示

点击每个按钮，可以在页面上看到相应的效果

㈡ webApi如何将一个页面

第一步：新建项目后，找到Global.asax文件----找到GlobalConfiguration.Configure(WebApiConfig.Register)方法------按F12进入 WebApiConfig.Register方法中----添加内容红框框

知识点：路由器注册顺序是由上往下的，会先从上面进行匹配。

路由器的名称不能重名，否则报错【CustomApi/DefaultApi】

第二步：设置webapi项目为启动项，然后启动，在网页路径上加api/values(控制器名称不要Controller)

知识点：因为ValuesController是项目自带的，那么这一次的请求与 DefaultApi的路由规格是一致的。

㈢ .Net有没有自动生成WebAPI接口的网站或工具

建议：别绕弯路，自己写一套根据当前业务相对比较健全的api接口表示层，然后复制粘贴修改
绝大部分api需求很多时候都是根据业务复杂驱动的，即便是api的表示层也得有：业务层反射问题，api author问题，返回数据约束问题，等等。此类工具少，即使有也很难满足业务需求。

㈣ 有没有大神分享一个纯python无框架写的webapi后端代码项目参考

你可能有误解，无框架要比使用框架复杂的多。
你刚学完，应该是先试试简单的框架。

㈤ 如何使 WebAPI 自动生成漂亮又实用在线API文档

1.1 SwaggerUI

SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。

1.2 Swashbuckle

Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。

2.快速开始

创建项目 OnlineAPI来封装网络音乐服务(示例下载) ，通过API可以搜索、获取音乐的信息和播放连接。

我尽量删除一些我们demo中不会用到的一些文件，使其看上去比较简洁。

WebAPI 安装 Swashbuckle

Install-Package Swashbuckle

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

将配置文件大概99行注释去掉并修改为
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

并在当前类中添加一个方法

/// <summary>
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}

紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”，编译过程中生成类库的注释文件

添加网络音乐 3个API

访问 http://<youhost>/swagger/ui/index,最终显示效果

我们通过API 测试API 是否成功运行

3.添加自定义HTTP Header

在开发移动端 API时常常需要验证权限，验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可

首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Filters;
using Swashbuckle.Swagger;

namespace OnlineAPI.Utility
{
public class HttpHeaderFilter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry
schemaRegistry, ApiDescription apiDescription)
{
if (operation.parameters == null) operation.parameters = new
List<Parameter>();
var filterPipeline =
apiDescription.ActionDescriptor.GetFilterPipeline();
//判断是否添加权限过滤器
var isAuthorized = filterPipeline.Select(filterInfo =>
filterInfo.Instance).Any(filter => filter is IAuthorizationFilter);
//判断是否允许匿名方法
var allowAnonymous =
apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any();

if (isAuthorized && !allowAnonymous)
{
operation.parameters.Add(new Parameter
{
name = "access-key",
@in = "header",
description = "用户访问Key",
required = false,
type = "string"
});
}
}
}
}

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<HttpHeaderFilter>();

添加Web权限过滤器
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using Newtonsoft.Json;

namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class AccessKeyAttribute : AuthorizeAttribute
{
/// <summary>
/// 权限验证
/// </summary>
/// <param name="actionContext"></param>
/// <returns></returns>
protected override bool IsAuthorized(HttpActionContext actionContext)
{
var request = actionContext.Request;
if (request.Headers.Contains("access-key"))
{
var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();
//TODO 验证Key
return accessKey == "123456789";
}
return false;
}

/// <summary>
/// 处理未授权的请求
/// </summary>
/// <param name="actionContext"></param>
protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
{
var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});
actionContext.Response = new HttpResponseMessage
{
Content = new StringContent(content, Encoding.UTF8, "application/json"),
StatusCode = HttpStatusCode.Unauthorized
};
}
}
}

在你想要的ApiController 或者是 Action 添加过滤器
[AccessKey]

最终显示效果

4.显示上传文件参数

SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似，只是我们通过特殊的设置来标示API具有上传文件的功能
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http.Description;
using Swashbuckle.Swagger;

namespace OnlineAPI.Utility
{
/// <summary>
///
/// </summary>
public class UploadFilter : IOperationFilter
{

/// <summary>
/// 文件上传
/// </summary>
/// <param name="operation"></param>
/// <param name="schemaRegistry"></param>
/// <param name="apiDescription"></param>
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
if (!string.IsNullOrWhiteSpace(operation.summary) && operation.summary.Contains("upload"))
{
operation.consumes.Add("application/form-data");
operation.parameters.Add(new Parameter
{
name = "file",
@in = "formData",
required = true,
type = "file"
});
}
}
}
}

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<UploadFilter>();

API 文档展示效果

㈥ webapi 怎么逐步调试代码

PreApplicationStart字面上看是在Application_Start之前执行的，把它放到Application_Start之内，肯定不行

㈦ 创建C#的wpf项目（C/S架构），不知道C/S架构中能不能用webapi,请高人解答，谢谢！

首先 ，你要明白浏览器也是客户端，只不过他提供的是一套通用的解释方式，具体执行程序放在了服务器上，服务器应用跟本地应用，本质上无差异，基本都是Sever+客户端处理，WPF是可以调用web api的 sever收到http请求可不管你是谁 是什么样的客户端发来的 只要是正确的http请求 就能响应，

㈧ vs2015创建web api有什么用途

在新出的MVC中，增加了WebAPI，用于提供REST风格的WebService，新生成的WebAPI项目和典型的MVC项目一样，包含主要的Models、Views、Controllers等文件夹和Global.asax文件。Views对于WebAPI来说没有太大的用途，Models中的Model主要用于保存Service和Client交互的对象，这些对象默认情况下会被转换为Json格式的数据迚行传输，Controllers中的Controller对应于WebService来说是一个Resource，用于提供服务。和普通的MVC一样，Global.asax用于配置路由规则。
对于WebAPI来说它最初被设计为和WCF一样的客户端、服务端两套结构我们到现在乊所以还没有提到客户端是因为我们的请求别的方式来封装成HTTP请求戒接收HTTP相应的比如AJAX和Form表单提交。

㈨ .net中MVC web项目和webapi有啥区别

首先要重点说的是，Web API是一种无限接近于RESTful风格的轻型框架，且不是微软提出来的，微软在.NET上实现了这中框架—http://Asp.Net
Web API，所以“微软包装”是一个极大的偏见。

就应用市场时间而论，MVC普及市场的时间比Web API时间早。为什么MVC提出来了，且都被大家公认是一种经典的web站点实现架构，为什么还要搞Web API呢？

这两年什么炒得最火热？互联网。在网络技术不断更新和替代的过程，网络不断普及。互联网产品只要你有技术，就可以做。但要说明的是，互联网产品的用户不再是一小部分人群，除了潜在用户，你需要面对的是庞大的上网人群和开发者。这时候你要考虑你的WEB服务器是否能够支持这么多的用户，节省一点点传输数据的带宽都能够让你的服务器轻松不少，除此之外，你还要考虑你的潜在用户变成你的真实用户的某刻时刻，你的服务器是否能够顺利支撑。

面对用户，你要考虑你的产品是否能够让用户使用起来感觉很“爽”，你要把用户体验放在首位，那么你的产品首先功能上必须稳定，不然即使有再好的创意，再耐心的用户总会使用其它产品替代你的产品。

面对开发者，你想要把某些功能开放，这时候你必须要开放某些接口。有人会说，我也可以使用MVC来开放这些接口，没错是可以，但是绕远道给你带来的是更大的代价。

Web API 和 MVC可以说是两个不同的东西。Web API更倾向于基于HTTP协议的服务，直接返回用户的数据请求。MVC是建站的一种框架，倾向于返回用户的页面请求。

我总结了以下 http://ASP.NET Web API 的特性，更能说明Web API是一种数据请求框架：

• http://ASP.NET
  Web API 可以根据请求报文来返回的相应数据格式。包括JSON和XML。
  

• http://ASP.NET
  Web API 单独做数据请求和MVC做页面请求可以让Web前端和后台更好的解耦，减少开发难度。
  

• Web API 可以更好地用在移动端网页、桌面端网页或者桌面程序。
  

• Web API 的宿主可以选择多样：WebHost,，ConsoleHost，甚至是windows Services。

类似可以理解成ashx和webform的区别

㈩ .net web api实例应该如何写

由于我机器装的是win8企业版操作系统，VS版本是2012，因此我们选择使用VS自带的MVC4模版中的Web API来创建一个项目。

点击确定后，VS会自动为我们创建一个完整的可运行的ASP.NET Web API的项目。
从项目的目录结构可以看出，ASP.NET Web API与ASP.NET MVC项目的结构几乎一致。我们删除为我们默认创建并打开的ValuesController文件（示例性文件，可以参考）。
既然要打造一个IP地址查询服务接口，为了跟上文的服务形式一致，我们还是使用GET请求方式的服务，不过我们这次使用MVC中的Web API来实现。
首先在Models文件夹中建立一个Address模型类。

?

1
2
3
4
5
6
7
8
9

namespace MvcWebApi.Models
{
public class Address
{
public string IPAddress { get; set; }
public string Province { get; set; }
public string City { get; set; }
}
}

接着我们在Controllers文件夹下建立一个IPAddressController控制器，需要注意的是，这个IPAddressController一定要继承自ApiController类，这样服务才能暴露出来。

?

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

namespace MvcWebApi.Controllers
{
public class IPAddressController : ApiController
{
private static IList addresses = new List
{
new Address(){ IPAddress="1.91.38.31", Province="北京市", City="北京市" },
new Address(){ IPAddress = "210.75.225.254", Province = "上海市", City = "上海市" },
};

public IEnumerable GetIPAddresses()
{
return addresses;
}

public Address GetIPAddressByIP(string IP)
{
return addresses.FirstOrDefault(x => x.IPAddress == IP);
}

}
}</address></address></address>

只要做上面两步就可以运行这个项目了，我们按Ctrl+F5运行整个项目，出现了如下的页面。

我们点击右上角的API链接。

可以看到我们定义的Web API的接口的使用方法以及说明。
既然是服务，能够被其它程序调用就需要一个持续保障它运行的环境，我们可以将这个写好的Web API的项目发布到IIS当中。
我们可以使用VS自带的发布功能进行发布，并映射到IIS应用程序目录当中。

我们点击IIS右侧的浏览，看看服务有没有能够正常运行。

我们按照文档的提示，我们在地址栏输入http://192.168.0.2/webapi/api/ipaddress。

可以看到，我们收到了Web API定义的服务提供的数据。同样的我们试一下另外一个接口方法。

OK，这样就好了。
但是如果我们需要返回JSON格式怎么办呢？有个简便的方法，在Global.asax.cs文件中，添加一个方法即可。

关于这段代码的原因，可以参考：http://blog.miniasp.com/post/2012/10/12/ASPNET-Web-API-Force-return-JSON-format-instead-of-XML-for-Google-Chrome-Firefox-Safari.aspx，这里不重复。
我们运行这个项目后，重复发布。
当我们再次在浏览器中运行时，就可以看到默认返回的是JSON格式了（IE默认就是JSON）。

ASP.NET Web API就开发好了，至于在C#程序中怎么调用，可以参考我上篇博客中的代码。如果要在页面中调用，可以通过jQuery等JS库请求URL即可。