Skip to content

Latest commit

 

History

History
23 lines (17 loc) · 1.02 KB

README.md

File metadata and controls

23 lines (17 loc) · 1.02 KB
Raw

Adminio openAPI Specification

  • OpenAPI version: 3.0

What is OpenAPI?

The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for REST APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. more info

How to use it?

  1. Start adminio-api
  2. Change servers>url in openapi_v3.yaml to actual adminio-api endpoint
  3. Open openAPI/openapi_v3.yaml in any of this tools:
  1. Make some API requests

or can generate standalone html file with redoc-cli

$ npm install -g redoc-cli
$ redoc-cli bundle -o index.html openapi_v3.yaml