In this five-part article series, you will learn how to manipulate your API behavior with a local proxy server. After setting the scene with an introduction, we will now learn how to set up the Charles Proxy and its configuration

Article series

  1. Introduction
  2. Charles Proxy Setup & Configuration
  3. Charles Proxy in Action
  4. Fiddler Setup & Configuration (coming soon)
  5. Fiddler in Action (coming soon)

To get started, please follow the official instructions to install Charles on your preferred platform.

On Windows, Charles is automatically configuring your system and browser settings to route all traffic through it when you start the program. The same applies to macOS when you confirm the permission dialog.

On Linux, things are slightly different. You have two options:

  1. Setting your http_proxy and https_proxy environment variables to localhost:8888. Many applications use the environment variables and, in general, will affect most of your network traffic.
  2. Installing a browser add-on for easy toggling between proxy on/off just for browser traffic, e.g., Proxy SwitchyOmega add-on for Chrome.

SSL Decryption

If you are going to work with HTTPS, you also need to set up SSL decryption. Without it, all traffic would be encrypted directly between API and frontend - which is good! With SSL decryption enabled, Charles will establish two secure connections. One to the API and one to the frontend. This way, Charles can read messages from both sides. It is a classic man-in-the-middle.

Follow these steps to activate SSL decryption. Replace *.mockapi.io with your API, e.g., api.example.com.

Setup Charles SSL Proxy feature

When you have already pointed your browser to Charles and are browsing to an SSL-decrypted page, you will notice a security warning about an invalid certificate authority.

Invalid certificate authority

Your browser is mistrusting Charles' certificate, which is a good thing (otherwise, SSL would be entirely worthless).

To fix this, you need to either trust each site's certificate permanently or trust the Charles root certificate. Read more about the platform specifications here.

Recording Your Traffic

Assuming you have everything up and running, you can now start your first traffic recording session. Click on the "Start Recording" button and wait a couple of seconds.

You will probably see a massive list of connections. Yes, browsers are very chatty, especially with many tabs opened.

First Charles traffic recording

With default settings, we see every single connection from our browser. We can fix this quickly: In the menu, click "Proxy" → "Recording Settings" → "Include" and then add your API's hostname. For this demonstration, we're using the services of mockapi.io to create a simple REST API.

Charles record settings

You may have to restart Charles at this point, to apply the new settings without having some weird glitches.

Deactivate Caching

It's essential to take care of caching. In case your API sends caching headers, Charles will serve cached contents automatically, and you will not be able to inspect a response's body. In the menu bar, click "Tools" → "No Caching".

Our first record will now look like this:

First filtered Charles traffic recording

On the right side, the upper box shows the request, the bottom one the response.

Conclusion

In this short article, we have taken a look at how to install and set up Charles Proxy to record traffic and decrypt SSL traffic for testing and debugging purposes. Charles makes this process flawless, and we will use this as a base for the upcoming articles.

In the third article of this series, you will see Charles Proxy in action.

Verpassen Sie keine Artikel mehr zu Tools & co

Melden Sie sich bei unserem kostenlosen monatlichen Newsletter an, um die aktuellen technischen Artikel unserer Experten zu den Themen Angular, .NET, Blazor, Azure und Kubernetes zu erhalten.

Bitte geben Sie eine gültige E-Mail-Adresse ein

Related Articles

tools
Fiddler in Action: Mocking and Manipulating API Behavior With a Local Proxy Server - Part 5
Article series Introduction Charles Proxy Setup & Configuration Charles Proxy in Action Fiddler Setup & Configuration Fiddler in Action Mission 1: Testing the Frontend Against Various API Responses The todo demo API returns a JSON array with three objects, each with an and…
Thinktecture Team
tools
Charles Proxy in Action: Mocking and Manipulating API Behavior with a Local Proxy Server - Part 3
In this five-part article series, you will learn how to manipulate your API behavior with a local proxy server. After setting the scene with an introduction and learning how to set up and configure Charles Proxy, we will now take a look at Charles Proxy in action. You will gain…
Thinktecture Team
tools
Introduction: Mocking and Manipulating API Behavior With a Local Proxy Server - Part 1
When it comes to developing against an HTTPS/REST API, which we do not control ourselves, we face many problems regularly. Issues and hard to provoke edge cases may include a wrong implementation, an incomplete implementation or connection problems (dial-in issues, dropping…
Thinktecture Team
azure
Introducing: Azure Cognitive Search - Part 1
TODO: HIER SOLLTE NOCH EIN SINNVOLLES INTRO KOMMEN... quasi der Executive Summary In this article series, you will learn how to ... in order to achieve ... and improve ... / prevent issues like.... . This article provides an introduction and... into how... In most of my projects…
Steffen Jahr