This document provides an overview of this nate tech submission.
To spin the application up locally run the following command from the root directory of the repo.
docker-compose up -d
With this, containers for the api, celery, redis and postgres will be span up. The application is served on port 8004.
To see the API documentation open the following:
localhost:8004/docs
There are a number of endpoints which can be used.
Returns the health status of other services. This response will be in the form:
{
"service_a": "HEALTHY",
"service_b": "UNHEALTHY",
}
Creates a page object and kicks off a task to scrape the given target_url.
This endpoint will return the ID of the new Page object:
{
"page_id": 1,
}
Lists out the page objects in full
Retrieves the individual page object and the corresponding results.
The results can be ordered with the query parameter ordering.