#if DEBUG  //This controller is not needed in production release, // since the client API should be generated during development of the Web Api.
...namespace Fonlow.WebApiClientGen
{[System.Web.Http.Description.ApiExplorerSettings(IgnoreApi = true)]//this controller is a //dev backdoor during development, no need to be visible in ApiExplorer.public class CodeGenController : ApiController{/// <summary>/// Trigger the API to generate WebApiClientAuto.cs for an established client API project./// POST to  http://localhost:10965/api/CodeGen with json object CodeGenParameters/// </summary>/// <param name="parameters"></param>/// <returns>OK if OK</returns>[HttpPost]public string TriggerCodeGen(CodeGenParameters parameters){
...}}

备注

//config.SetDocumentationProvider(new XmlDocumentationProvider
(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

取消注释，使其像这样：

config.SetDocumentationProvider(new XmlDocumentationProvider
(HttpContext.Current.Server.MapPath("~/bin/Your.WebApi.xml")));

在项目“属性”页面的“Build”选项卡中，检查“输出/XML文档文件”并设置“bin\Your.WebApi.xml”，而输出路径默认情况下为“bin”。

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配置数据将POST到CodeGen Web API：

{"ApiSelections": {"ExcludedControllerNames": ["DemoWebApi.Controllers.Account","DemoWebApi.Controllers.FileUpload"],"DataModelAssemblyNames": ["DemoWebApi.DemoData","DemoWebApi"],"CherryPickingMethods": 3},"ClientApiOutputs": {"ClientLibraryProjectFolderName": "..\\DemoWebApi.ClientApi","GenerateBothAsyncAndSync": true,"CamelCase": true,"Plugins": [{"AssemblyName": "Fonlow.WebApiClientGen.jQuery","TargetDir": "Scripts\\ClientApi","TSFile": "WebApiJQClientAuto.ts","AsModule": false,"ContentType": "application/json;charset=UTF-8"},{"AssemblyName": "Fonlow.WebApiClientGen.NG2","TargetDir": "..\\DemoNGCli\\NGSource\\src\\ClientApi","TSFile": "WebApiNG2ClientAuto.ts","AsModule": true,"ContentType": "application/json;charset=UTF-8"}]}
}

建议将JSON配置数据保存到Web API项目文件夹中的此类文件中。

/// <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,
}

默认值是opt-in的DataContract。您可以使用任何一种方法或方法的组合。

/// <reference path="../typings/jquery/jquery.d.ts" />
/// <reference path="HttpClient.ts" />
namespace DemoWebApi_DemoData_Client {export enum AddressType {Postal, Residential}export enum Days {Sat=1, Sun=2, Mon=3, Tue=4, Wed=5, Thu=6, Fri=7}export interface Address {Id?: string;Street1?: string;Street2?: string;City?: string;State?: string;PostalCode?: string;Country?: string;Type?: DemoWebApi_DemoData_Client.AddressType;Location?: DemoWebApi_DemoData_Another_Client.MyPoint;}export interface Entity {Id?: string;Name: string;Addresses?: Array<DemoWebApi_DemoData_Client.Address>;}export interface Person extends DemoWebApi_DemoData_Client.Entity {Surname?: string;GivenName?: string;BirthDate?: Date;}export interface Company extends DemoWebApi_DemoData_Client.Entity {BusinessNumber?: string;BusinessNumberType?: string;TextMatrix?: Array<Array<string>>;Int3D?: Array<Array<Array<number>>>;Lines?: Array<string>;}
}namespace DemoWebApi_DemoData_Another_Client {export interface MyPoint {X?: number;Y?: number;}
}namespace DemoWebApi_Controllers_Client {export class Entities {httpClient: HttpClient;constructor(public baseUri?: string, public error?: (xhr: JQueryXHR, ajaxOptions: string, thrown: string) => any, public statusCode?: { [key: string]: any; }){this.httpClient = new HttpClient();}/*** Get a person* GET api/Entities/{id}* @param {number} id unique id of that guy* @return {DemoWebApi_DemoData_Client.Person} person in db*/GetPerson(id: number, callback: (data : DemoWebApi_DemoData_Client.Person) => any){this.httpClient.get(encodeURI(this.baseUri + 'api/Entities/'+id), callback, this.error, this.statusCode);}/*** POST api/Entities* @param {DemoWebApi_DemoData_Client.Person} person* @return {number}*/CreatePerson(person: DemoWebApi_DemoData_Client.Person, callback: (data : number) => any){this.httpClient.post(encodeURI(this.baseUri + 'api/Entities'), person, callback, this.error, this.statusCode);}/*** PUT api/Entities* @param {DemoWebApi_DemoData_Client.Person} person* @return {void}*/UpdatePerson(person: DemoWebApi_DemoData_Client.Person, callback: (data : void) => any){this.httpClient.put(encodeURI(this.baseUri + 'api/Entities'), person, callback, this.error, this.statusCode);}/*** DELETE api/Entities/{id}* @param {number} id* @return {void}*/Delete(id: number, callback: (data : void) => any){this.httpClient.delete(encodeURI(this.baseUri + 'api/Entities/'+id), callback, this.error, this.statusCode);}}export class Values {httpClient: HttpClient;constructor(public baseUri?: string, public error?: (xhr: JQueryXHR, ajaxOptions: string, thrown: string) => any, public statusCode?: { [key: string]: any; }){this.httpClient = new HttpClient();}/*** GET api/Values* @return {Array<string>}*/Get(callback: (data : Array<string>) => any){this.httpClient.get(encodeURI(this.baseUri + 'api/Values'), callback, this.error, this.statusCode);}/*** GET api/Values/{id}?name={name}* @param {number} id* @param {string} name* @return {string}*/GetByIdAndName(id: number, name: string, callback: (data : string) => any){this.httpClient.get(encodeURI(this.baseUri + 'api/Values/'+id+'?name='+name), callback, this.error, this.statusCode);}/*** POST api/Values* @param {string} value* @return {string}*/Post(value: {'':string}, callback: (data : string) => any){this.httpClient.post(encodeURI(this.baseUri + 'api/Values'), value, callback, this.error, this.statusCode);}/*** PUT api/Values/{id}* @param {number} id* @param {string} value* @return {void}*/Put(id: number, value: {'':string}, callback: (data : void) => any){this.httpClient.put(encodeURI(this.baseUri + 'api/Values/'+id), value, callback, this.error, this.statusCode);}/*** DELETE api/Values/{id}* @param {number} id* @return {void}*/Delete(id: number, callback: (data : void) => any){this.httpClient.delete(encodeURI(this.baseUri + 'api/Values/'+id), callback, this.error, this.statusCode);}}
}

提示

config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();

如果C＃中的相应名称是Pascal式格式，则属性名称和函数名称将是驼峰式格式。有关更多详细信息，请检查camelCasing或PascalCasing。

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

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