mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-25 14:35:48 +03:00
Code Issues Projects Releases Packages Wiki Activity
AdGuardHome/openapi
History
Jonas Marklén 037bf43b40
Updated openapi.yaml to OpenAPI 3.0 
Included lint to validate yaml file
2020-04-16 22:04:00 +02:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
CHANGELOG.md Merge: * openapi changelog 2020-03-13 12:11:52 +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 Updated openapi.yaml to OpenAPI 3.0 2020-04-16 22:04:00 +02:00
package.json Updated openapi.yaml to OpenAPI 3.0 2020-04-16 22:04:00 +02:00
README.md + Login page and web sessions 2019-09-19 12:47:55 +03:00
yarn.lock Updated openapi.yaml to OpenAPI 3.0 2020-04-16 22:04:00 +02: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.