请选择 进入手机版 | 继续访问电脑版
  • 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

WebApiProxy: AspNet WebAPI Proxy JavaScript CSharp

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

WebApiProxy

开源软件地址:

https://gitee.com/jucheap/WebApiProxy

开源软件介绍:

https://github.com/RestCode/WebApiProxy此源码根据个人需求,做了一些更改。

WebApiProxy

This project comprises of a server-side extension that provides an proxy end-point for serving service metadata & a client-side proxy in JavaScript and also a client-side task that generates a client proxy in C#.

Service-side Proxy provider

Getting startedInstall via NuGet

Extend your ASP.NET Web API service by installing this package from NuGet:

Install-Package WebApiProxy

Note: This package requires the core libraries of ASP.NET Web API (version 5 or higher)

Register proxy endpoint

You need to explicitly register the proxy endpoint route. You can do this by using the RegisterProxyRoutes extension method that extends HttpConfiguration:

config.RegisterProxyRoutes();

Note: Make sure to include the WebApiProxy.Server namespace

This will register your service with an additional endpoint with the default address as /api/proxies'. It is also possible to specify a custom address by passing therouteTemplate` parameter:

config.RegisterProxyRoutes("$metadata");

Usage

This extension provides a proxy endpoint in your service (with /api/proxies as the default) that serves JavaScript and service metadata.

Given a Person API on the server:

public class PeopleController : ApiController{    public Person[] Get() {    }    public Person Get(int id) {    }}

allows you to use it like this in JavaScript on the client:

$.proxies.person.get()  .done(function(people) {    //do something with people  });$.proxies.person.get(2)  .done(function(person) {    //do something with person  });

JavaScript proxySimply reference the proxy endpoint provided inside your HTML and you're good to go:

<script src="/api/proxies" type="text/javascript"></script>

This functionality was adopted from ProxyApi - kudos to Stephen Greatrex :)

Getting the service Metadata

Invoke the service on its proxy endpoint api/proxies with the request header X-Proxy-Type as "metadata" and the service metadata including documentation will be in the response.

Excluding controllers

You can exclude your controllers by simply decorating them with the ExcludeProxy attribute

Client-side Proxy Generator

Generate a C# proxy on the client-side based on the metadata provided by a service implementing WebApiProxy.Install via NuGet

Install this package from NuGet:

Install-Package WebApiProxy.CSharp

Note: This package requires the libraries of ASP.NET Web API Client (version 5.2 or higher)

Generation

Note: The automatic generation of code upon project build is now completely opt-in. You need to explicitly specify if you want the proxy to be generated on every build.

The C# proxy code will be generated every time you re-build the project (only if you explicitly specified generateOnBuild="true") and is based on specific configuration in the WebApiProxy.config file:

<proxy endpoint="http://myservice.net/api/proxies" />

The endpoint property is mandatory and provides the generator the URI of the metadata endpoint. See the WebApiProxy Configuration File page to read more on the config file.

Note: The generated code is cached to avoid compilation errors if the service isn't reachable at that time

Proxy generation using the Nuget Package Manager Console

You can also generate proxy code on demand by using the Nuget Package Manager Console. Simply run the commandlet:

WebApiProxy-Generate-CSharp

Usage

Given a PeopleController on the service-side:

public class PeopleController : ApiController{        /// <summary>        /// Gets all people with a given the name        /// </summary>        /// <param name="name">The criteria to search for</param>        /// <returns>People collection</returns>        public Person[] Get(string name)        {            return new Person[]{                new Person { Id = 3, FirstName = "sss", LastName = "sqqqq"},                new Person { Id = 3, FirstName = "sss", LastName = "sqqqq"}            };        }}

can be used like this on the client-side:

using (var client = new PeopleClient()){    var response = await client.GetAsync("Fanie");    var people = await response.Content.ReadAsAsync<Person[]>();}

Code snippet

Use the webapiproxy code snippet to quickly create the code structure above. Just type "webapiproxy" followed by the TAB key.

Note: If the types are not found (or resolved) after build, simply give your project a restart or restart Visual Studio.

Great developer experience with Intellisense

It even has nice Intellisense including documentation provided by the documentation provider:

输入图片说明

Note: The documentation on the Intellisense will only appear if the service uses the documentation provider. You can use the ASP.NET Web API Help Page package on NuGet


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap