badguardhome/openapi at 53767a5bedaac0025379e2a8b3ce02f1a8d79d30 - badguardhome - Gitea: Git with a cup of tea

History

Andrey Meshkov 53767a5bed *(documentation): bump openapi spec version to 0.98.1		2019-08-22 15:42:43 +03:00
..
.gitignore	Added swagger UI scripts	2018-12-28 18:26:14 +03:00
README.md	Change openapi doc port from 3000 to 4000 to avoid clashing with adguardhome.	2018-12-28 18:26:14 +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	*(documentation): bump openapi spec version to 0.98.1	2019-08-22 15:42:43 +03:00
package.json	Change openapi doc port from 3000 to 4000 to avoid clashing with adguardhome.	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

yarn install
yarn start
Open http://localhost:4000/