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>
pull/1331/head
Kévin Commaille 2 years ago
parent 498cf6d147
commit 9b4773498a
No known key found for this signature in database
GPG Key ID: DD507DAE96E8245C

@ -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, 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: 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 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 via an * You can run a local HTTP server by running `./scripts/swagger-http-server.py`, and then view the documentation by
online viewer; for example, at <http://petstore.swagger.io/?url=http://localhost:8000/api-docs.json>. opening `./scripts/swagger-preview.html` in your browser.
* 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.
## Issue tracking ## Issue tracking

@ -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>
Loading…
Cancel
Save