Update instructions to preview Swagger definitions

Use RapiDoc, the same library used in production. It is also compatible with OpenAPI 3.1. Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2 years ago · 9b4773498a
parent 498cf6d147
commit 9b4773498a
2 changed files with 16 additions and 5 deletions
--- a/README.md
+++ b/README.md
@ -90,11 +90,9 @@ For building the swagger definitions, create a python3 virtualenv and activate i
 and finally `python ./scripts/dump-swagger.py` to generate it to `./scripts/swagger/api-docs.json`. To make use of the generated file,
 there are a number of options:

-* It can be uploaded from your filesystem to an online editor/viewer such as [on the swagger website](http://editor.swagger.io/).
-* You can run a local HTTP server by running `./scripts/swagger-http-server.py`, and then view the documentation via an
-  online viewer; for example, at <http://petstore.swagger.io/?url=http://localhost:8000/api-docs.json>.
-* You can host the swagger UI yourself. See <https://github.com/swagger-api/swagger-ui#how-to-run> for advice on how to
-  do so.
+* You can open `./scripts/swagger-preview.html`in your browser, and then open the file by clicking on `Local JSON File`.
+* You can run a local HTTP server by running `./scripts/swagger-http-server.py`, and then view the documentation by
+  opening `./scripts/swagger-preview.html` in your browser.

 ## Issue tracking

--- a/scripts/swagger-preview.html
+++ b/scripts/swagger-preview.html
@ -0,0 +1,13 @@
+<!doctype html>
+<html>
+
+<head>
+    <meta charset="utf-8">
+    <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+</head>
+
+<body>
+    <rapi-doc spec-url="http://localhost:8000/api-docs.json"> </rapi-doc>
+</body>
+
+</html>