mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2025-01-01 11:38:18 +03:00
20e56b7171
Merge in DNS/adguard-home from more-md-lint to master
Squashed commit of the following:
commit 39e7ea3b441ebf48c5b0d5c2b5b85620515bbea3
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Thu Dec 19 17:03:36 2024 +0300
all: imp docs more
commit 7aa08036b239d7eb19f674a6c4bfaf1325ff4bff
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date: Thu Dec 19 16:08:13 2024 +0300
all: add more docs to lint
|
||
|---|---|---|
| .. | ||
| 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.