WebScraper API (1.0.0)

Download OpenAPI specification:

REST API for the webscraper database.

root

Redirect to API docs

Redirects to the API documentation at /docs/index.html.

Responses

routes

List all routes

Returns all routes in the database.

Responses

Response samples

200

Content type

application/json

[{"id": "fc1abf41-5d4c-44d9-ac73-b0849f8255bb",
"name": "Bear Creek Canyon",
"type": "Canyon",
"coordinates": {"lat": -111.456,
"lon": 40.123
}
},
{"id": "2bf9d566-66d8-4f60-b6eb-ebbbf04f4f19",
"name": "Devil Gulch",
"type": "Unknown",
"coordinates": {"lat": -111.5,
"lon": 40.2
}
}
]

docs

Serve API documentation

Returns the built API documentation files.

index.html - Redoc HTML documentation
openapi.yaml - Bundled OpenAPI spec (YAML)
openapi.json - Bundled OpenAPI spec (JSON)

path Parameters

file

required

string

Enum: "index.html" "openapi.yaml" "openapi.json"

The documentation file to return

Responses

Response samples

200
400

Content type

text/html

No sample