Strongly Typed Client API Generators generate strongly typed client API in C# codes and TypeScript codes. You may then provide or publish either the generated source codes or the compiled client API libraries to other developers for developing client programs.
This project delivers these products:
- Code generator for strongly typed client API in C# supporting desktop, Universal Windows, Android and iOS.
- Code generator for strongly typed client API in TypeScript for jQuery and Angular 2.
- TypeScript CodeDOM, a CodeDOM component for TypeScript, derived from CodeDOM of .NET Framework.
- POCO2TS.exe, a command line program that generates TypeScript interfaces from POCO classes.
- Fonlow.Poco2Ts, a component that generates TypeScript interfaces from POCO classes.
- The packages could be used independently as long as the usages conform to the dependencies.
- Client API codes generated are directly mapped from the Web API controller methods, .NET primitive types and POCO classes. This is similar to what svcutil.exe in WCF has offered.
- Doc comments of controller methods and POCO classes are copied.
- WebApiClientGen is seamlessly integrated with ASP.NET Web API with very little steps/overheads to setup, maintain and synchronize between Web API and client APIs, during RAD or Agile Software Development.
- Support all .NET primitive types including decimal.
- Support DataTime, DataTimeOffset, Array, Tuple, Dynamic Object, Dictionary and KeyValuePair
- Strongly typed generated codes are subject to design time type checking and compile time type checking.
- Provide high level of abstraction, shielding application developers from repetitive technical details of RESTful practices and traditional AJAX calls.
- Rich meta info including doc comments make IDE intellisense more helpful, so application developers have less need of reading separated API documents.
- POCO classes
- Web API
- Generated client API C# codes
- Client codes using the generated library in C#
- Generated client data models and API in TypeScript for jQuery and for Angular 2
- Client codes using the generated library in TypeScript
For .NET Framework
- Strongly Typed Client API Generators for ASP.NET Web API.
- TypeScript CodeDOM
For .NET Core
- Web API vendors / developers should provide client API libraries to developers of client programs, as Google and Amazon etc. would do in order to make the RESTful Web API reach wider consumers (internal and external) efficiently.
- To client developers, classic function prototypes like
ReturnType DoSomething(Type1 t1, Type2 t2 ...)is the API function, and the rest is the technical implementation details of transportations: TCP/IP, HTTP, SOAP, resource-oriented, CRUD-based URIs, RESTful, XML and JSON etc. The function prototype and a piece of API document should be good enough for calling the API function.
- The better you have separation of concerns in your Web API design, the more you will benefit from the components of this project in order to deliver business values sooner, with less handcrafted codes , less repetitive tasks and less chances of human mistakes.
- .NET Framework 4.5.2, or .NET Core 2.0
- ASP.NET Web API 2.2, or ASP.NET Core 2.0
.NET client side:
- .NET Framework 4.5.2, or Universal Windows, or Mono.Android, or Xamarin.iOS, or .NET Core 2.0/2.1
- ASP.NET Web API 2.2 Client Libraries
- Json.NET of Newtonsoft for Content-Type application/json
- Microsoft Build Tools 2015
TypeScript client side:
- TypeScript compiler
- Angular 2/4/5/6 and its dependencies in node_modules supported by Node.js and npm.
For more details, please check WIKI, and codeproject.com articles at:
- Generate C# .NET Client API for ASP.NET Web API
- Generate TypeScript Client API for ASP.NET Web API
- ASP.NET Web API, Angular2, TypeScript and WebApiClientGen
- Generate C# Client API for ASP.NET Core Web API
The Demo applications in this repository are mainly for testing WebApiClientGen during development. And there are other demo applications in the following repositories, demostrating how real world applications could utilize WebApiClientGen:
These demo applications are actively maintained and kept up-to-date with the latest frameworks. If you are still staying with some older frameworks like Angular 4 or 5 or .NET Core 2.0, you may navigate to respective tags of the repositories and checkout.