#if DEBUG  //This controller is not needed in production release, //since the client API should be generated during development of the Web API
using Fonlow.CodeDom.Web;
using System.Linq;
using System.Web.Http;namespace Fonlow.WebApiClientGen
{[System.Web.Http.Description.ApiExplorerSettings(IgnoreApi = true)]//this controller //is a dev backdoor during development, no need to be visible in ApiExplorerpublic class CodeGenController : ApiController{/// <summary>/// Trigger the API to generate WebApiClientAuto.cs /// for an established client API project./// </summary>/// <param name="settings"></param>/// <returns>OK if OK</returns>[HttpPost]public IHttpActionResult TriggerCodeGen(CodeGenSettings settings){if (settings == null)return BadRequest("No settings");if (settings.ClientApiOutputs == null)return BadRequest("No settings/ClientApiOutputs");string webRootPath = System.Web.Hosting.HostingEnvironment.MapPath("~");Fonlow.Web.Meta.WebApiDescription[] apiDescriptions;try{apiDescriptions = Configuration.Services.GetApiExplorer().ApiDescriptions.Select(d => Fonlow.Web.Meta.MetaTransform.GetWebApiDescription(d)).OrderBy(d => d.ActionDescriptor.ActionName).ToArray();}catch (System.InvalidOperationException e){System.Diagnostics.Trace.TraceWarning(e.Message);return InternalServerError(e);}if (!settings.ClientApiOutputs.CamelCase.HasValue){var camelCase = GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.ContractResolver is Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver;settings.ClientApiOutputs.CamelCase = camelCase;}try{CodeGen.GenerateClientAPIs(webRootPath, settings, apiDescriptions);}catch (Fonlow.Web.Meta.CodeGenException e){var s = e.Message + " : " + e.Description;System.Diagnostics.Trace.TraceError(s);return BadRequest(s);}return Ok("Done");}}}
#endif

备注

namespace DemoWebApi.DemoData
{public sealed class Constants{public const string DataNamespace = "http://fonlow.com/DemoData/2014/02";}[DataContract(Namespace = Constants.DataNamespace)]public enum AddressType{[EnumMember]Postal,[EnumMember]Residential,};[DataContract(Namespace = Constants.DataNamespace)]public enum Days{[EnumMember]Sat = 1,[EnumMember]Sun,[EnumMember]Mon,[EnumMember]Tue,[EnumMember]Wed,[EnumMember]Thu,[EnumMember]Fri};[DataContract(Namespace = Constants.DataNamespace)]public class Address{[DataMember]public Guid Id { get; set; }public Entity Entity { get; set; }/// <summary>/// Foreign key to Entity/// </summary>public Guid EntityId { get; set; }[DataMember]public string Street1 { get; set; }[DataMember]public string Street2 { get; set; }[DataMember]public string City { get; set; }[DataMember]public string State { get; set; }[DataMember]public string PostalCode { get; set; }[DataMember]public string Country { get; set; }[DataMember]public AddressType Type { get; set; }[DataMember]public DemoWebApi.DemoData.Another.MyPoint Location;}[DataContract(Namespace = Constants.DataNamespace)]public class Entity{public Entity(){Addresses = new List<Address>();}[DataMember]public Guid Id { get; set; }[DataMember(IsRequired =true)]//MVC and Web API does not care[System.ComponentModel.DataAnnotations.Required]//MVC and Web API care about only thispublic string Name { get; set; }[DataMember]public IList<Address> Addresses { get; set; }public override string ToString(){return Name;}}[DataContract(Namespace = Constants.DataNamespace)]public class Person : Entity{[DataMember]public string Surname { get; set; }[DataMember]public string GivenName { get; set; }[DataMember]public DateTime? BirthDate { get; set; }public override string ToString(){return Surname + ", " + GivenName;}}[DataContract(Namespace = Constants.DataNamespace)]public class Company : Entity{[DataMember]public string BusinessNumber { get; set; }[DataMember]public string BusinessNumberType { get; set; }[DataMember]public string[][] TextMatrix{ get; set; }[DataMember]public int[][] Int2DJagged;[DataMember]public int[,] Int2D;[DataMember]public IEnumerable<string> Lines;}...
...namespace DemoWebApi.Controllers
{[RoutePrefix("api/SuperDemo")]public class EntitiesController : ApiController{/// <summary>/// Get a person/// </summary>/// <param name="id">unique id of that guy</param>/// <returns>person in db</returns>[HttpGet]public Person GetPerson(long id){return new Person(){Surname = "Huang",GivenName = "Z",Name = "Z Huang",BirthDate = DateTime.Now.AddYears(-20),};}[HttpPost]public long CreatePerson(Person p){Debug.WriteLine("CreatePerson: " + p.Name);if (p.Name == "Exception")throw new InvalidOperationException("It is exception");Debug.WriteLine("Create " + p);return 1000;}[HttpPut]public void UpdatePerson(Person person){Debug.WriteLine("Update " + person);}[HttpPut][Route("link")]public bool LinkPerson(long id, string relationship, [FromBody] Person person){return person != null && !String.IsNullOrEmpty(relationship);}[HttpDelete]public void Delete(long id){Debug.WriteLine("Delete " + id);}[Route("Company")][HttpGet]public Company GetCompany(long id){

JSON有效负载是这样的：

{"ApiSelections": {"ExcludedControllerNames": ["DemoWebApi.Controllers.Account","DemoWebApi.Controllers.FileUpload"],"DataModelAssemblyNames": ["DemoWebApi.DemoData","DemoWebApi"],"CherryPickingMethods": 3},"ClientApiOutputs": {"ClientLibraryProjectFolderName": "..\\DemoWebApi.ClientApi","GenerateBothAsyncAndSync": true,"Plugins": []}
}

有效负载示例随v1.8.0一起提供，并且可以在此处找到早期版本。

/// <summary>
/// Flagged options for cherry picking in various development processes.
/// </summary>
[Flags]
public enum CherryPickingMethods
{/// <summary>/// Include all public classes, properties and properties./// </summary>All = 0,/// <summary>/// Include all public classes decorated by DataContractAttribute,/// and public properties or fields decorated by DataMemberAttribute./// And use DataMemberAttribute.IsRequired/// </summary>DataContract =1,/// <summary>/// Include all public classes decorated by JsonObjectAttribute,/// and public properties or fields decorated by JsonPropertyAttribute./// And use JsonPropertyAttribute.Required/// </summary>NewtonsoftJson = 2,/// <summary>/// Include all public classes decorated by SerializableAttribute,/// and all public properties or fields/// but excluding those decorated by NonSerializedAttribute./// And use System.ComponentModel.DataAnnotations.RequiredAttribute./// </summary>Serializable = 4,/// <summary>/// Include all public classes, properties and properties./// And use System.ComponentModel.DataAnnotations.RequiredAttribute./// </summary>AspNet = 8,
}

默认选项是“选择加入”的DataContract。您可以使用任何一种方法或方法的组合。

namespace DemoWebApi.DemoData.Client
{    public enum AddressType{        Postal,        Residential,}public enum Days{        Sat = 1,        Sun = 2,        Mon = 3,        Tue = 4,        Wed = 5,        Thu = 6,        Fri = 7,}public class Address : object{        private System.Guid _Id;        private string _Street1;        private string _Street2;        private string _City;        private string _State;        private string _PostalCode;        private string _Country;        private DemoWebApi.DemoData.Client.AddressType _Type;        private DemoWebApi.DemoData.Another.Client.MyPoint _Location;        public System.Guid Id{get{return _Id;}set{_Id = value;}}public string Street1{get{return _Street1;}set{_Street1 = value;}}public string Street2{get{return _Street2;}set{_Street2 = value;}}public string City{get{return _City;}set{_City = value;}}public string State{get{return _State;}set{_State = value;}}public string PostalCode{get{return _PostalCode;}set{_PostalCode = value;}}public string Country{get{return _Country;}set{_Country = value;}}public DemoWebApi.DemoData.Client.AddressType Type{get{return _Type;}set{_Type = value;}}public DemoWebApi.DemoData.Another.Client.MyPoint Location{get{return _Location;}set{_Location = value;}}}public class Entity : object{private System.Guid _Id;private string _Name;private DemoWebApi.DemoData.Client.Address[] _Addresses;public System.Guid Id{get{return _Id;}set{_Id = value;}}[System.ComponentModel.DataAnnotations.RequiredAttribute()]public string Name{get{return _Name;}set{_Name = value;}}public DemoWebApi.DemoData.Client.Address[] Addresses{get{return _Addresses;}set{_Addresses = value;}}}public class Person : DemoWebApi.DemoData.Client.Entity{private string _Surname;private string _GivenName;private System.Nullable<System.DateTime> _BirthDate;public string Surname{get{return _Surname;}set{_Surname = value;}}public string GivenName{get{return _GivenName;}set{_GivenName = value;}}public System.Nullable<System.DateTime> BirthDate{get{return _BirthDate;}set{_BirthDate = value;}}}public class Company : DemoWebApi.DemoData.Client.Entity{private string _BusinessNumber;private string _BusinessNumberType;private string[][] _TextMatrix;private int[][] _Int2DJagged;private int[,] _Int2D;private string[] _Lines;public string BusinessNumber{get{return _BusinessNumber;}set{_BusinessNumber = value;}}public string BusinessNumberType{get{return _BusinessNumberType;}set{_BusinessNumberType = value;}}public string[][] TextMatrix{get{return _TextMatrix;}set{_TextMatrix = value;}}public int[][] Int2DJagged{get{return _Int2DJagged;}set{_Int2DJagged = value;}}public int[,] Int2D{get{return _Int2D;}set{_Int2D = value;}}public string[] Lines{get{return _Lines;}set{_Lines = value;}}}public class MyPeopleDic : object{private System.Collections.Generic.Dictionary<string, DemoWebApi.DemoData.Client.Person> _Dic;private System.Collections.Generic.Dictionary<string, string> _AnotherDic;private System.Collections.Generic.Dictionary<int, string> _IntDic;public System.Collections.Generic.Dictionary<string, DemoWebApi.DemoData.Client.Person> Dic{get{return _Dic;}set{_Dic = value;}}public System.Collections.Generic.Dictionary<string, string> AnotherDic{get{return _AnotherDic;}set{_AnotherDic = value;}}public System.Collections.Generic.Dictionary<int, string> IntDic{get{return _IntDic;}set{_IntDic = value;}}}
}
namespace DemoWebApi.DemoData.Another.Client
{    public struct MyPoint{public double X;public double Y;}
}public partial class Entities{private System.Net.Http.HttpClient client;private System.Uri baseUri;public Entities(System.Net.Http.HttpClient client, System.Uri baseUri){if (client == null)throw new ArgumentNullException("client", "Null HttpClient.");if (baseUri == null)throw new ArgumentNullException("baseUri", "Null baseUri");this.client = client;this.baseUri = baseUri;}/// <summary>////// PUT api/SuperDemo/link?id={id}&relationship={relationship}/// </summary>public async Task<bool> LinkPersonAsync(long id, string relationship, DemoWebApi.DemoData.Client.Person person){var requestUri = this.baseUri + "api/SuperDemo/link?id="+id+"&relationship="+relationship;using (var requestWriter = new System.IO.StringWriter()){var requestSerializer = JsonSerializer.Create();requestSerializer.Serialize(requestWriter, person);var content = new StringContent(requestWriter.ToString(), System.Text.Encoding.UTF8, "application/json");var responseMessage = await client.PutAsync(requestUri, content);responseMessage.EnsureSuccessStatusCode();var stream = await responseMessage.Content.ReadAsStreamAsync();using (JsonReader jsonReader = new JsonTextReader(new System.IO.StreamReader(stream))){var serializer = new JsonSerializer();return System.Boolean.Parse(jsonReader.ReadAsString());}}}/// <summary>////// PUT api/SuperDemo/link?id={id}&relationship={relationship}/// </summary>public bool LinkPerson(long id, string relationship, DemoWebApi.DemoData.Client.Person person){var requestUri = this.baseUri + "api/SuperDemo/link?id="+id+"&relationship="+relationship;using (var requestWriter = new System.IO.StringWriter()){var requestSerializer = JsonSerializer.Create();requestSerializer.Serialize(requestWriter, person);var content = new StringContent(requestWriter.ToString(), System.Text.Encoding.UTF8, "application/json");var responseMessage = this.client.PutAsync(requestUri, content).Result;responseMessage.EnsureSuccessStatusCode();var stream = responseMessage.Content.ReadAsStreamAsync().Result;using (JsonReader jsonReader = new JsonTextReader(new System.IO.StreamReader(stream))){var serializer = new JsonSerializer();return System.Boolean.Parse(jsonReader.ReadAsString());}}}/// <summary>////// GET api/SuperDemo/Company?id={id}/// </summary>public async Task<DemoWebApi.DemoData.Client.Company> GetCompanyAsync(long id){var requestUri = this.baseUri + "api/SuperDemo/Company?id="+id;var responseMessage = await client.GetAsync(Uri.EscapeUriString(requestUri));responseMessage.EnsureSuccessStatusCode();var stream = await responseMessage.Content.ReadAsStreamAsync();using (JsonReader jsonReader = new JsonTextReader(new System.IO.StreamReader(stream))){var serializer = new JsonSerializer();return serializer.Deserialize<DemoWebApi.DemoData.Client.Company>(jsonReader);}}/// <summary>////// GET api/SuperDemo/Company?id={id}/// </summary>public DemoWebApi.DemoData.Client.Company GetCompany(long id){var requestUri = this.baseUri + "api/SuperDemo/Company?id="+id;var responseMessage = this.client.GetAsync(Uri.EscapeUriString(requestUri)).Result;responseMessage.EnsureSuccessStatusCode();var stream = responseMessage.Content.ReadAsStreamAsync().Result;using (JsonReader jsonReader = new JsonTextReader(new System.IO.StreamReader(stream))){var serializer = new JsonSerializer();return serializer.Deserialize<DemoWebApi.DemoData.Client.Company>(jsonReader);}}

如果希望某些外部开发人员使用您的Web API，则可以发布针对各种平台的C＃客户端API代码或编译的库，以及由ASP.NET MVC框架生成的帮助页面。

var httpclient = new system.net.http.httpclient();
var api = new demowebapi.controllers.client.entities(httpclient, baseuri);
person person = new person()
{name = "some one",surname = "one",givenname = "some",birthdate = datetime.now.addyears(-20),addresses = new address[]{new address(){city="brisbane",state="qld",street1="somewhere",street2="over the rainbow",postalcode="4000",country="australia",type= addresstype.postal,location = new demowebapi.demodata.another.client.mypoint() {x=4, y=9 },}},
};var id = api.createperson(person);

在像Visual Studio这样的不错的文本编辑器中编写客户端代码时，您可能会得到很好的智能提示，因此您几乎不需要阅读Web API帮助页面。

ReturnType DoSomething(Type1 t1, Type2 t2 ...)

是API函数，其余是传输的技术实现细节：TCP / IP，HTTP，SOAP，面向资源，基于CRUD的URI，RESTful，XML和JSON等。函数原型和一段API文档应该足以调用API函数。至少在操作成功时，客户端应用程序开发人员不必关心传输的那些实现细节。仅当出现错误时，开发人员才需要关心处理错误的技术细节。例如，在基于SOAP的Web服务中，您必须了解SOAP错误。在RESTful Web服务中，您可能必须处理HTTP状态代码。