mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-12-15 19:31:45 +03:00
14 lines
397 B
Markdown
14 lines
397 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/`
|