mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-12-03 16:34:13 +03:00
Code Issues Projects Releases Packages Wiki Activity
AdGuardHome/openapi
History
Ainar Garipov f2c6e1c682 Pull request: openapi: fix more docs issues 
Merge in DNS/adguard-home from fix-openapi to master

Squashed commit of the following:

commit bd95a502666372443b937cbcb690e307cd943342
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Thu Jan 14 13:23:37 2021 +0300

    openapi: fix more docs issues
2021-01-14 13:48:52 +03:00
..
.gitignore
CHANGELOG.md Pull request: all: imp http handlers, imp docs 2021-01-13 17:26:57 +03:00
index.html
openapi.yaml Pull request: openapi: fix more docs issues 2021-01-14 13:48:52 +03:00
package.json
README.md Pull request: * home, openapi: improve docs and responses 2020-11-05 13:59:57 +03:00
yarn.lock

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/

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.