Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lrstanley/entrest
Extension that generates a compliant OpenAPI spec and server implementation
https://github.com/lrstanley/entrest
ent entity-framework go golang openapi openapi3 orm
Last synced: 18 days ago
JSON representation
Extension that generates a compliant OpenAPI spec and server implementation
- Host: GitHub
- URL: https://github.com/lrstanley/entrest
- Owner: lrstanley
- License: mit
- Created: 2024-06-02T17:24:14.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-10-07T16:29:29.000Z (about 1 month ago)
- Last Synced: 2024-10-16T03:44:32.020Z (30 days ago)
- Topics: ent, entity-framework, go, golang, openapi, openapi3, orm
- Language: Go
- Homepage: https://lrstanley.github.io/entrest/
- Size: 1.52 MB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
## :link: Table of Contents
- [Features](#sparkles-features)
- [Usage](#gear-usage)
- [Support & Assistance](#raising_hand_man-support--assistance)
- [Contributing](#handshake-contributing)
- [License](#balance_scale-license)
## :sparkles: Features
> [!WARNING]
> entrest is still a work in progress. we may make breaking changes to the API
> without notice.
**entrest** is an [EntGo](https://entgo.io/) extension for generating compliant OpenAPI
specs and an HTTP handler implementation that matches that spec. It expands upon the
approach used by [entoas](https://github.com/ent/contrib/tree/master/entoas#entoas),
with additional functionality, and pairs the generated specification with a
fully-functional HTTP handler implementation.
- :sparkles: Generates OpenAPI specs for your EntGo schema.
- :sparkles: Generates a fully functional HTTP handler implementation that matches the OpenAPI spec.
- :sparkles: Supports automatic pagination (where applicable).
- :sparkles: Supports advanced filtering (using query parameters, `AND`/`OR` predicates, etc).
- :sparkles: Supports eager-loading edges, so you don't have to make additional calls unnecessarily.
- :sparkles: Supports various forms of sorting.
- :sparkles: And more!
---
## :gear: Usage
Take a look at the [official documentation](https://lrstanley.github.io/entrest/) for guides, examples, and more.
```console
go get -u github.com/lrstanley/entrest@latest
```
---
## :raising_hand_man: Support & Assistance
* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for
guidelines on ensuring everyone has the best experience interacting with
the community.
* :raising_hand_man: Take a look at the [support](.github/SUPPORT.md) document on
guidelines for tips on how to ask the right questions.
* :lady_beetle: For all features/bugs/issues/questions/etc, [head over here](https://github.com/lrstanley/entrest/issues/new/choose).
## :handshake: Contributing
* :heart: Please review the [Code of Conduct](.github/CODE_OF_CONDUCT.md) for guidelines
on ensuring everyone has the best experience interacting with the
community.
* :clipboard: Please review the [contributing](.github/CONTRIBUTING.md) doc for submitting
issues/a guide on submitting pull requests and helping out.
* :old_key: For anything security related, please review this repositories [security policy](https://github.com/lrstanley/entrest/security/policy).
## :balance_scale: License
```
MIT License
Copyright (c) 2024 Liam Stanley
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
_Also located [here](LICENSE)_