Giter VIP home page Giter VIP logo

unirest-net's Introduction

Unirest for .Net

Unirest is a set of lightweight HTTP libraries available in multiple languages, built and maintained by Mashape, who also maintain the open-source API Gateway Kong.

This is a port of the Java library to .NET.

Installing

We're currently updating Nuget to point to the latest package. In the meantime, please download this entire unirest-net library and reference it in your project.

Creating Request

So you're probably wondering how using Unirest makes creating requests in .NET easier, here is a basic POST request that will explain everything:

HttpResponse<MyClass> jsonResponse = Unirest.post("http://httpbin.org/post")
  .header("accept", "application/json")
  .field("parameter", "value")
  .field("foo", "bar")
  .asJson<MyClass>();

Requests are made when as[Type]() is invoked, possible types include Json, Binary, String. If the request supports this, a body can be passed along with .body(String) or body<T>(T) to serialize an arbitrary object to JSON. If you already have a dictionary of parameters or do not wish to use seperate field methods for each one there is a .fields(Dictionary<string, object> parameters) method that will serialize each key - value to form parameters on your request.

.headers(Dictionary<string, string> headers) is also supported in replacement of multiple header methods.

Asynchronous Requests

Sometimes, well most of the time, you want your application to be asynchronous and not block, Unirest supports this in .NET with the TPL pattern and async/await:

Task<HttpResponse<MyClass>> myClassTask = Unirest.post("http://httpbin.org/post")
  .header("accept", "application/json")
  .field("param1", "value1")
  .field("param2", "value2")
  .asJsonAsync<MyClass>();

File Uploads

Creating multipart requests with .NET is trivial, simply pass along a Stream Object as a field:

byte[] data = File.ReadAllBytes(@"filePath");
HttpResponse<MyClass> myClass = Unirest.post("http://httpbin.org/post")
  .header("accept", "application/json")
  .field("parameter", "value")
  .field("files", data)
  .asJson<MyClass>();

Custom Entity Body

HttpResponse<MyClass> myClass = Unirest.post("http://httpbin.org/post")
  .header("accept", "application/json")
  .body("{\"parameter\":\"value\", \"foo\":\"bar\"}")
  .asJson<MyClass>();

Request

The .NET Unirest library follows the builder style conventions. You start building your request by creating a HttpRequest object using one of the following:

HttpRequest request = Unirest.get(String url);
HttpRequest request = Unirest.post(String url);
HttpRequest request = Unirest.put(String url);
HttpRequest request = Unirest.patch(String url);
HttpRequest request = Unirest.delete(String url);

Response

Upon recieving a response Unirest returns the result in the form of an Object, this object should always have the same keys for each language regarding to the response details.

  • .Code - HTTP Response Status Code (Example 200)
  • .Headers - HTTP Response Headers
  • .Body - Parsed response body where applicable, for example JSON responses are parsed to Objects / Associative Arrays.
  • .Raw - Un-parsed response body

Made with โ™ฅ from the Mashape team

unirest-net's People

Contributors

ismaelc avatar nijikokun avatar orthographic-pedant avatar sonicaghi avatar subnetmarco avatar ucodia avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

unirest-net's Issues

"internal server error" Error in POST request

I have used unirest-net in my .NET web application, I am able to view the album but not able to create album from API call. it give me an error of "internal server error". Also i was not able to consume API in windows based application using Unirest-net. Please help me out.

POST request is failing when Bearer token is used in .NET

Hi, I'm trying out the POST request with the Bearer token in both Java and .NET. The Java version works fine, but the .NET version is failing. Please find the request and the response below for .NET.

.NET:

Request:
HttpResponse<string> httpResponse = Unirest.post("https://gorest.co.in/public-api/users") .header("Content-Type", "application/json") .header("Accept", "application/json") .header("Authorization", "Bearer Z1UQZlHX3YYchYeqjd1M04ZiHq6XFhfbsKYT") .body(JObject.Parse("{\n \"first_name\": \"Brian\",\n \"last_name\": \"Ratke\",\n \"gender\": \"male\",\n \"email\": \"[email protected]\",\n \"status\": \"active\"\n}")) .asJson<string>();

Response:
{ "_meta": { "success": false, "code": 401, "message": "Authentication failed." }, "result": { "name": "Unauthorized", "message": "Your request was made with invalid credentials.", "code": 0, "status": 401 } }

Java:

Request:
HttpResponse<String> response = Unirest.post("https://gorest.co.in/public-api/users") .header("Content-Type", "application/json") .header("Accept", "application/json") .header("Authorization", "Bearer Z1UQZlHX3YYchYeqjd1M04ZiHq6XFhfbsKYT") .body("{\n \"first_name\": \"Brian\",\n \"last_name\": \"Ratke\",\n \"gender\": \"male\",\n \"email\": \"[email protected]\",\n \"status\": \"active\"\n}") .asString();

Response:
{"_meta":{"success":true,"code":201,"message":"A resource was successfully created in response to a POST request. The Location header contains the URL pointing to the newly created resource.","rateLimit":{"limit":30,"remaining":29,"reset":2}},"result":{"id":"1799","first_name":"Brian","last_name":"Ratke","gender":"male","dob":null,"email":"[email protected]","phone":null,"website":null,"address":null,"status":"active","_links":{"self":{"href":"https://gorest.co.in/public-api/users/1799"},"edit":{"href":"https://gorest.co.in/public-api/users/1799"},"avatar":{"href":null}}}}

Is there any resolution for the issue in .NET? Thanks.

Connection timeout

Is there any easy way to set the connection timeout? Something like this:

HttpResponse<MyClass> jsonResponse = Unirest.post("http://httpbin.org/post")
  .setTimeout(3000)
  .header("accept", "application/json")
  .field("parameter", "value")
  .field("foo", "bar")
  .asJson<MyClass>();

or I need to do it in HttpRequest?

HttpRequest request = Unirest.post(String url);

An example would be helpful. Thanks.

Target frameworks

I'm trying to use your library into my project. The project is a console application with .NET Framework 4 as Target Framework. Adding your project to my solution I can't compile. This is the error:
Error 4 The type or namespace name 'unirest_net' could not be found (are you missing a using directive or an assembly reference?)
Your project targets these environments:

  • .NET Framework 4 and higher
  • Silverlight 5
  • Windows Phone 8
  • WIndows Store apps (Windows 8) and higher

Is it possible to downgrade the target including not only Win 8 but at least Win 7?
Thanks

File upload with Unirest-net not working

I was trying to consume lambda API in my application where i have to upload a file:

.field("files", new MemoryStream("")) is not supported in Unirest-net.

HttpResponse response = Unirest.post("https://lambda-face-recognition.p.mashape.com/album_train")
.header("X-Mashape-Authorization", "wdfwerwerjjrlwernwlkrwlkrnewlrn")
.field("album", "")
.field("albumkey", "")
.field("entryid", "")
.field("files", new MemoryStream(""))
.field("urls", "")
.asJson();

Please resolve this issue by overloading the field method to (string, and stream)

.fields Not working

Hi - got a few problems using .fields with a string, object dictionary.

If using byte[] and uploading image then this fails and says no data provided
If using some simple string/value pairs then the values are always empty.

I've tried the headers/dictionary and that's fine, it's just for fields.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.