diff --git a/api.rst b/api.rst index d9e6e7398..e7bc52398 100644 --- a/api.rst +++ b/api.rst @@ -226,6 +226,10 @@ This returns OpenAPI Support =============== +Every API hosted by PostgREST automatically serves a full `OpenAPI `_ description on the root path. This provides a list of all endpoints, along with supported HTTP verbs and example payloads. + +You can use a tool like `Swagger UI `_ to create beautiful documentation from the description and host an interactive web-based dahsboard. The dashboard allows developers to make requests against a live PostgREST server, provides guidance with request headers and example request bodies. + Resource Embedding ==================