daxi20/AdGuardHome
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added swagger UI scripts

Browse Source
This commit is contained in:
Andrey Meshkov
2018-11-25 20:09:52 +03:00
committed by Eugene Bujak
parent 4623817894
commit 09702c724e
7 changed files with 474 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
openapi/README.md Normal file
View File

@@ -0,0 +1,13 @@
## 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:3000/`