jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

OpenAPI overview

Browse Source
This commit is contained in:
Joe Nelson
2016-11-20 22:41:05 -08:00
parent dacf39404e
commit 455dc5c8bc
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api.rst
+4
View File
@@ -226,6 +226,10 @@ This returns
OpenAPI Support OpenAPI Support
=============== ===============
Every API hosted by PostgREST automatically serves a full `OpenAPI <https://www.openapis.org/>`_ 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 <http://swagger.io/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 Resource Embedding
================== ==================