This commit is contained in:
Kfir Dayan 2023-05-31 15:30:31 +03:00
parent e49b986c8a
commit 9ac63c8db0

View file

@ -50,6 +50,10 @@ ## API Endpoints ##
# GET /api/crawl:
Crawls a website and stores the crawled data in the database. Required query parameter: url. Optional query parameter: depth (default: 1).
Parameters:
- `url` (required): The URL of the website to crawl.
- `depth` (optional): The depth of the crawling process (default: 1).
- `refresh` (optional): If set to true, the crawler will refresh the results for an existing URL (default: false).
# GET /api:
Retrieves all crawled data from the database.
# DELETE /api/crawl/{id}: