Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/postgrest/postgrest-openapi
OpenAPI output generated in SQL for a PostgREST instance
https://github.com/postgrest/postgrest-openapi
openapi openapi3 postgresql postgresql-extension postgrest
Last synced: 3 months ago
JSON representation
OpenAPI output generated in SQL for a PostgREST instance
- Host: GitHub
- URL: https://github.com/postgrest/postgrest-openapi
- Owner: PostgREST
- License: mit
- Created: 2023-05-10T02:33:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-11T22:01:59.000Z (3 months ago)
- Last Synced: 2024-11-11T23:18:00.488Z (3 months ago)
- Topics: openapi, openapi3, postgresql, postgresql-extension, postgrest
- Language: PLpgSQL
- Homepage:
- Size: 114 KB
- Stars: 20
- Watchers: 6
- Forks: 4
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PostgREST OpenAPI
SQL functions to build the OpenAPI output of a PostgREST instance.
## Roadmap
- The first step in the roadmap is to migrate the OpenAPI spec from the PostgREST core repository (version 2.0 to 3.1):
- [x] Info object
- [x] Server object (replaces host, basePath and schemes from OAS 2.0)
- [x] Components object
- [x] Schemas (definitions in OAS 2.0)
- [x] Security scheme (security definitions in OAS 2.0)
- [x] Parameters
- [x] Paths object
- [x] Tables and Views
- [x] GET
- [x] POST
- [x] PATCH
- [x] DELETE
- [x] Functions
- [x] GET
- [x] POST
- [ ] External Documentation Object
- [ ] Handle relevant OpenAPI elements according to user permissions
- The next step is to fix the issues tagged with `OpenAPI` in the core repo.
## Installation
```bash
make && sudo make install
```
## Development
Check the code documentation at [/docs](/docs) to familiarize yourself with the project structure and function usage.
For testing on your local database:
```bash
# this will load fixtures in a contrib_regression db on your local postgres
make fixtures
# run the tests, they can be run repeatedly
make installcheck
# to clean the fixtures you can use
make clean
```
For an isolated and reproducible enviroment you can use [Nix](https://nixos.org/download.html).
```bash
# to run tests
nix-shell --run "with-pg-15 make installcheck"
# to interact with the local database with fixtures loaded
nix-shell --run "with-pg-15 psql contrib_regression"
# you can choose the pg version
nix-shell --run "with-pg-13 make installcheck"
```
For those who insist on Docker:
```bash
# To build a docker image and run the tests in it
make docker-build-test
# To build a docker image for actual use
make docker-build
```
## References
- [OpenAPI 3 Specification Documentation](https://spec.openapis.org/oas/v3.1.0): The official documentation of the spec.
- [OpenAPI Specification Explained](https://learn.openapis.org/specification/): Introductory explanation of the spec.
- [OpenAPI Guide](https://swagger.io/docs/specification/about/): Detailed explanation for each concept of the spec, useful to build it from scratch.
- [OpenAPI Visual Map](http://openapi-map.apihandyman.io/?version=3.0): Visual representation of the spec using an interactive GUI to navigate through its components.