Skip to content
This repository was archived by the owner on Jun 24, 2022. It is now read-only.

Commit ee10547

Browse files
committed
Adds basic info to README.md
1 parent 0b457b8 commit ee10547

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
11
# cloudflare-api-schemas
22
Cloudflare API JSON Schemas (+extraction tool)
3+
4+
**Why**: It's 2022, devs want to use API schemas to generate modern API wrappers (strictly typed, for example). Cloudflare doesn't provide access to their API schemas for unknown reasons, even their official Python wrapper uses beautifulsoup to parse their own docs.
5+
6+
**What**: This repository provides schemas and a tool to extract them (`scripts/extractor.py`, just run `make` to generate fresh schemas). I don't guarantee that extracted schemas are identical to the original (hidden), but it's enough to build projects (wrappers, pentest, and so on) on top of it.
7+
8+
**How**: Obviously CF uses some toolchain [1] to generate their docs from internally available API schemas. Part of this job is reflected in the minified js app bundle used by the official documentation website. I use `esprima` js parser to convert js objects containing meaningful information to Python dicts, to serialize them to back JSON schemas.
9+
10+
[1] https://blog.cloudflare.com/cloudflares-json-powered-documentation-generator/

0 commit comments

Comments
 (0)