-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated swagger README for clarity on how to view swagger docs (#320)
- Loading branch information
Showing
1 changed file
with
4 additions
and
16 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 |
---|---|---|
@@ -1,20 +1,8 @@ | ||
# KERI Interactive Web Interface API | ||
## OpenAPI spec (3.1.0) with SwaggerUI (5.0.0-alpha.9) | ||
|
||
The contents of this directory, other than this Readme, are pulled from the | ||
[5.0.0-alpha.9 release](https://github.com/swagger-api/swagger-ui/releases/tag/v5.0.0-alpha.9) release page | ||
in the `/dist` directory of the downloadable .zip file. | ||
To view swaggerUI just serve the contents of this directory to a web browser where you'll get a nice UI to view the swagger docs for this project. ie) | ||
|
||
## Upgrading | ||
Go to the [swagger-ui releases](https://github.com/swagger-api/swagger-ui/releases) page, download the .zip file for the | ||
release you want to upgrade to, extract the `/dist` directory contents, clear the `/static/swaggerui` contents in this | ||
repository, place the contents of `/dist` from the zip file into `/static/swaggerui` and then update the | ||
`swagger-initializer.js` file to point to `spec.yaml` rather than `https://petstore.swagger.io/v2/swagger.json`. | ||
|
||
## Notice on alpha version | ||
The Swagger UI is an early alpha version and some things may be broken, though it has to do with the newest of features | ||
so all the typical features likely work just fine. | ||
|
||
See [this article](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0) for a comparison of | ||
OpenAPI 3.0.x and 3.1.0. That article also links to another article with an in depth explanation of the new features in | ||
OpenAPI 3.1.0 and the changes from 3.0.x. | ||
```bash | ||
python -m http.server 1337 | ||
``` |