mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-12-15 19:31:45 +03:00
0a5888f27a
Merge in DNS/adguard-home from upd-domains-and-links to master
Squashed commit of the following:
commit 5e5ff2fec358104995877da689da24749ac470ce
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Thu Jul 28 19:53:19 2022 +0300
all: upd urls
Update domains and URLs to make them more resistant to state blocking.
|
||
|---|---|---|
| .. | ||
| .gitignore | ||
| CHANGELOG.md | ||
| index.html | ||
| openapi.yaml | ||
| package.json | ||
| README.md | ||
| v1.yaml | ||
| yarn.lock | ||
AdGuard Home OpenAPI
We are using OpenAPI specification to generate AdGuard Home API specification.
How To Edit The API Spec
The easiest way would be to use Swagger Editor and just copy/paste the YAML file there.
How To Read The API Doc
yarn installyarn start- Open
http://localhost:4000/
Changelog
Here we keep track of all non-compatible changes that are being made.
Authentication
If AdGuard Home's web user is password-protected, a web client must use
authentication mechanism when sending requests to server. Basic access
authentication is the most simple method - a client must pass Authorization
HTTP header along with all requests:
Authorization: Basic BASE64_DATA
Where BASE64_DATA is base64-encoded data for username:password string.