mirrors
/
AdGuardHome
mirror of https://github.com/AdguardTeam/AdGuardHome.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
AdGuardHome/openapi
History
Simon Zolin 92b6adbdc1 * openapi: minor 2019-10-14 15:56:14 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
README.md + Login page and web sessions 2019-09-19 12:47:55 +03:00
index.html Added swagger UI scripts 2018-12-28 18:26:14 +03:00
index.js Change openapi doc port from 3000 to 4000 to avoid clashing with adguardhome. 2018-12-28 18:26:14 +03:00
openapi.yaml * openapi: minor 2019-10-14 15:56:14 +03:00
package.json Change openapi doc port from 3000 to 4000 to avoid clashing with adguardhome. 2018-12-28 18:26:14 +03:00
yarn.lock Added swagger UI scripts 2018-12-28 18:26:14 +03:00

README.md

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

  1. yarn install
  2. yarn start
  3. Open http://localhost:4000/

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.