ReadMe.io

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Reference FAQs

Hey! Have you come here from our message in the console?

This probably means you're having some issues... but don't worry, we're here to help. Often any issues you're experiencing have been dealt with by someone else in the past.

If you do not see your problem listed below but are using a custom domain in addition to a CDN/caching layer (Cloudflare/CloudFront etc) then please rule out this being a part of the problem before contacting us. To do this, go directly to your subdomain.readme.io domain and test if you're still experiencing the issue.

If you're still having problems, do not hesitate to email us at support@readme.io detailing your problem in as much detail as you can.

Swagger questions?

If you have any questions related to how we process and render your swagger files, please view our swagger docs: https://readme.readme.io/v2.0/docs/swagger-specification

Cloudflare: HTTPS -> HTTP Mixed content warning when making requests?

If you see something that looks like the following in your console:

Mixed Content: The page at 'https://docsite.readme.io/reference' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://try.readme.io/https://api.example.com/token'. This request has been blocked; the content must be served over HTTPS.

You need to make sure that Cloudflare is setup to accept requests over HTTPS and is not performing any redirects to the HTTP site. You may also see some network requests like the following:

This shows a cancelled request to the Cloudflare API via our proxy, then a Location header sent on the response which Chrome then attempts to follow and causes the above error.

Cloudflare: Site not updating after dash changes

If you are a Cloudflare customer, you need to make sure that you purge Cloudflare's cache after you make changes. The changes you make will not be reflected otherwise.

Cloudflare: Suggested Edits not working

You need to make sure that Cloudflare is passing through any cookies that we set on our response. Suggested edits will not work without this as we will not know if the user is logged in or not.

Cloudflare: DNS pointed to prohibited IP

We do utilize Cloudflare for our API explorer, and Cloudflare doesn't allow Cloudflare requests to be proxied over Cloudflare to prevent loops from occurring. You can turn off the proxy in your reference settings, but you need to make sure you allow readme.io in your CORS.

Reference FAQs