44
55# ApiProber -- Passive API Discovery and Documentation Tool
66
7+ [ ![ ApiProber smoke tests] ( https://github.com/dev-bricks/apiprober/actions/workflows/tests.yml/badge.svg )] ( https://github.com/dev-bricks/apiprober/actions/workflows/tests.yml )
8+
79ApiProber is a zero-dependency Python CLI for passive API discovery. It helps
810developers and maintainers map undocumented REST services, compare live
911behavior with API documentation, persist observations in SQLite, and export
@@ -13,6 +15,18 @@ Markdown or JSON documentation.
1315
1416---
1517
18+ ## Start Here
19+
20+ | Goal | Command or File |
21+ | ---| ---|
22+ | Try the CLI | ` python api_prober.py --help ` |
23+ | Map an authorized API | ` python api_prober.py probe <base-url> ` |
24+ | Export documentation | ` python api_prober.py export <service> --format md ` |
25+ | Read machine context | [ ` llms.txt ` ] ( llms.txt ) |
26+ | Report a vulnerability privately | [ ` SECURITY.md ` ] ( SECURITY.md ) |
27+
28+ ---
29+
1630## Best Fit
1731
1832- Internal REST services where no OpenAPI file exists
@@ -180,7 +194,12 @@ ApiProber/
180194
181195` passive API discovery ` , ` REST API documentation generator ` , ` OpenAPI detection ` ,
182196` HATEOAS link crawler ` , ` local-first API reconnaissance ` , `zero-dependency Python
183- CLI` , ` SQLite API inventory` , ` ethical API probing`
197+ CLI` , ` SQLite API inventory` , ` ethical API probing` , ` authorized API inventory`,
198+ ` REST endpoint mapper `
199+
200+ ApiProber is unrelated to Cloudprober, probe-rs, code-search probe tools, and
201+ active uptime monitoring systems. Its focus is local, rate-limited REST API
202+ surface documentation for systems you own or are explicitly allowed to assess.
184203
185204---
186205
0 commit comments