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即可。