Skip to content
The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.
C++ CMake C HTML Shell JavaScript Other
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Replace CPPREST_TARGET_XP with version checks, remove ""s, and other … Jul 13, 2019
Build_android Update boost-for-android for Android NDK r20 and disable macOS Homebr… Jul 12, 2019
Build_iOS Fix broken CI Builds (#1156) Jun 13, 2019
Release Support for WinHTTPAL curl-to-WinHTTP adapter (#1182) Sep 27, 2019
azure-devops Avoid using permissive- with ZW which breaks VS2019 (#1248) Sep 27, 2019
vcpkg @ ee0bfad Avoid using permissive- with ZW which breaks VS2019 (#1248) Sep 27, 2019
.clang-format clang-format cpprestsdk (#1005) Dec 21, 2018
.gitignore Replace CPPREST_TARGET_XP with version checks, remove ""s, and other … Jul 13, 2019
.gitmodules Avoid using permissive- with ZW which breaks VS2019 (#1248) Sep 27, 2019
CMakeLists.txt Enable testing from root directory (#1064) Mar 19, 2019
CONTRIBUTORS.txt json: {"meow"} is not a valid object (#1130) May 7, 2019
README.md Add install instructions for Fedora (#919) Oct 16, 2018
ThirdPartyNotices.txt Update ThirdPartyNotices.txt to only cover websocketpp, since boost a… Oct 18, 2016
azure-pipelines.yml Support for WinHTTPAL curl-to-WinHTTP adapter (#1182) Sep 27, 2019
changelog.md
license.txt Update license to MIT Oct 18, 2016

README.md

Welcome!

The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.

Getting Started

Vcpkg package
Homebrew package
Ubuntu 18.04 package
Fedora Rawhide package
openSUSE Tumbleweed package
Debian Testing package

Build Status

With vcpkg on Windows

PS> vcpkg install cpprestsdk cpprestsdk:x64-windows

With apt-get on Debian/Ubuntu

$ sudo apt-get install libcpprest-dev

With dnf on Fedora

$ sudo dnf install cpprest-devel

With brew on OSX

$ brew install cpprestsdk

With NuGet on Windows for Android

PM> Install-Package cpprestsdk.android

For other platforms, install options, how to build from source, and more, take a look at our Documentation.

Once you have the library, look at our tutorial to use the http_client. It walks through how to setup a project to use the C++ Rest SDK and make a basic Http request.

To use from CMake:

cmake_minimum_required(VERSION 3.7)
project(main)

find_package(cpprestsdk REQUIRED)

add_executable(main main.cpp)
target_link_libraries(main PRIVATE cpprestsdk::cpprest)

What's in the SDK:

  • Features - HTTP client/server, JSON, URI, asynchronous streams, WebSockets client, oAuth
  • PPL Tasks - A powerful model for composing asynchronous operations based on C++ 11 features
  • Platforms - Windows desktop, Windows Store (UWP), Linux, OS X, Unix, iOS, and Android
  • Support for Visual Studio 2015 and 2017 with debugger visualizers

Contribute Back!

Is there a feature missing that you'd like to see, or found a bug that you have a fix for? Or do you have an idea or just interest in helping out in building the library? Let us know and we'd love to work with you. For a good starting point on where we are headed and feature ideas, take a look at our requested features and bugs.

Big or small we'd like to take your contributions back to help improve the C++ Rest SDK for everyone. If interested contact us askcasablanca at Microsoft dot com.

Having Trouble?

We'd love to get your review score, whether good or bad, but even more than that, we want to fix your problem. If you submit your issue as a Review, we won't be able to respond to your problem and ask any follow-up questions that may be necessary. The most efficient way to do that is to open an issue in our issue tracker.

Quick Links

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

You can’t perform that action at this time.