Get visibility into how your API works today. Optic learns your API's current behavior by observing traffic.
- How many endpoints are in your API?
- Is your current API specification accurate? complete? How do you know?
- Passive (Live Environments)
Capture Traffic by using your API / App:
api start command for your framework. Requests to the API when its run with Optic's CLI will be captured
Intercept traffic from your browser's network tab. Just run
api intercept and API calls you see in the Network Tab will be captured by Optic.
Capture Traffic by running your API tests
api test command for your framework:
Capture Traffic from your other API Tools:
Explore some common deployed capture scenarios with Optic:
Let's check if we've captured enough traffic to start documenting our API. Run
api status -- we should see some new URLs to document:
$ api status Computing API diffs... Done!✓ No diffs observed for existing endpoints Undocumented URLs observed (use "api status --review" to start documenting them GET /todos PATCH /todos/mc6ttk3vv POST /todos/
Nice work! Let's move to the next step: Documenting!