Counterpart backend API for the whatsth.is project. It currently has the following functions
- Website technology inspection (follows this definition file).
- DNS record inspection at a high level.
Want to quickstart? With Docker/Podman installed, Run:
docker run -p 80:80 ghcr.io/soup-bowl/whatsthis-api:latest
This API has Swagger documentation on the homepage.
You can over-ride the default API settings using environmental variables.
| Environmental Key | Default | Purpose |
|---|---|---|
REDIS_URL |
None | Caching & storage agent. |
WTAPI_DEFINITION_URL |
Latest definitions | Can provide a different YAML or JSON source for the detection definitions. |
Use Kestrel to run the server. This is achieved by running the following (post depedency installation - see below):
dotnet run --project Whatsthis.APIBy default, the server will be available at http://localhost:43594.
Run docker-compose up --build to start the server locally (runs on port 43594).
This project uses NuGet to manage dependencies.
dotnet dev-certs https
dotnet restore
dotnet build
dotnet run --project Whatsthis.APIThis project uses xUnit for tests, and can be run by executing:
dotnet test