add support for OpenAPI rendering via ReDoc (#414) (#720)

* add support for OpenAPI rendering via ReDoc (#414)

* add support for OpenAPI rendering via ReDoc (#414)
This commit is contained in:
Tom Kralidis
2021-06-30 11:11:57 -04:00
committed by GitHub
parent 7ecac02693
commit 167281ee83
6 changed files with 45 additions and 4 deletions
+9 -2
View File
@@ -21,8 +21,8 @@ The API is accessible at the ``/openapi`` endpoint, providing a Swagger-based we
the pygeoapi demo OpenAPI/Swagger endpoint at https://demo.pygeoapi.io/master/openapi
Using OpenAPI
-------------
Using OpenAPI via Swagger
-------------------------
Accessing the Swagger webpage we have the following structure:
@@ -62,6 +62,13 @@ This identifier can be used to obtain a specific item from the dataset using the
.. image:: /_static/openapi_get_item_id2.png
Using OpenAPI via ReDoc
-----------------------
pygeoapi also supports OpenAPI document rendering via `ReDoc <https://redoc.ly/>`_.
ReDoc rendering is accessible at the same ``/openapi`` endpoint, adding ``ui=redoc`` to the request URL.
Summary
-------