mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-22 13:05:36 +03:00
02d16a0b40
Merge in DNS/adguard-home from 2243-better-docs to master Closes #2243. Squashed commit of the following: commit 26c655a0e4339528870633c2cdf39c3b5c486b1d Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Nov 5 12:51:43 2020 +0300 * openapi: improve more commit dc0ab9857787d14eb0686814a4f3c8f917698bee Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Nov 3 20:40:32 2020 +0300 * home, openapi: improve docs and responses
35 lines
894 B
Markdown
35 lines
894 B
Markdown
# AdGuard Home OpenAPI
|
|
|
|
We are using
|
|
[OpenAPI specification](https://swagger.io/docs/specification/about/)
|
|
to generate AdGuard Home API specification.
|
|
|
|
## How To Edit The API Spec
|
|
|
|
The easiest way would be to use
|
|
[Swagger Editor](http://editor.swagger.io/)
|
|
and just copy/paste the YAML file there.
|
|
|
|
## How To Read The API Doc
|
|
|
|
1. `yarn install`
|
|
2. `yarn start`
|
|
3. Open `http://localhost:4000/`
|
|
|
|
## Changelog
|
|
|
|
[Here](CHANGELOG.md) 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:
|
|
|
|
```http
|
|
Authorization: Basic BASE64_DATA
|
|
```
|
|
|
|
Where BASE64_DATA is base64-encoded data for `username:password` string.
|