mirrors
/
AdGuardHome
mirror of https://github.com/AdguardTeam/AdGuardHome.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
AdGuardHome/openapi
History
Andrey Meshkov 09702c724e Added swagger UI scripts 2018-12-28 18:26:14 +03:00
..
.gitignore Added swagger UI scripts 2018-12-28 18:26:14 +03:00
README.md Added swagger UI scripts 2018-12-28 18:26:14 +03:00
index.html Added swagger UI scripts 2018-12-28 18:26:14 +03:00
index.js Added swagger UI scripts 2018-12-28 18:26:14 +03:00
openapi.yaml Added swagger UI scripts 2018-12-28 18:26:14 +03:00
package.json Added swagger UI scripts 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:3000/