AdGuardHome/openapi/README.md

## 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/`
Added swagger UI scripts 2018-11-25 20:09:52 +03:00			`## 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`
Change openapi doc port from 3000 to 4000 to avoid clashing with adguardhome. 2018-12-12 17:25:42 +03:00			3. Open `http://localhost:4000/`