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

History

Simon Zolin 5ad9f8ead2 * tlsConfigStatus.usable is public, renamed ("ValidPair") and is exported to json ("valid_pair")		2019-02-27 17:36:02 +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	* tlsConfigStatus.usable is public, renamed ("ValidPair") and is exported to json ("valid_pair")	2019-02-27 17:36:02 +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/