-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from rzrbld/future-release-1_1
remove openapi.html and update deps
- Loading branch information
Showing
5 changed files
with
121 additions
and
396 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## Adminio openAPI v3 specification | ||
|
||
### 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](http://spec.openapis.org/oas/v3.0.3) | ||
|
||
### How to use it? | ||
|
||
you can open and try out with this tools: | ||
- [Insomnia designer](https://insomnia.rest/products/designer/) | ||
- [Online swagger edtor](https://editor.swagger.io/) | ||
|
||
or can generate standalone html file with [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) | ||
``` | ||
$ npm install -g redoc-cli | ||
$ redoc-cli bundle -o index.html openapi_v3.yaml | ||
``` |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.