On the target

Import an OpenAPI document

You do not need this box for a normal scan. Use it when an API route is never linked from the page.

1. 01

   Paste an OpenAPI 3 JSON document

   The box on the target page accepts the document. Paths that are not on this host are ignored. An empty paths object imports nothing.

2. 02

   Or publish the spec on the host

   A document already at /openapi.json or /swagger.json is read on the next scan. You can leave the box empty in that case.

3. 03

   Run the scan

   Imported routes are probed with the same checks as routes the crawl discovered. Path parameters such as {id} are filled with a sample value before the request is sent.

{
  "openapi": "3.0.0",
  "paths": {
    "/api/invoices/{id}": {
      "get": { "responses": { "200": { "description": "One invoice" } } }
    }
  }
}