:link: Table of Contents
:sparkles: Features
[!WARNING] entrest is still a work in progress. we may make breaking changes to the API without notice.
entrest is an EntGo extension for generating compliant OpenAPI specs and an HTTP handler implementation that matches that spec. It expands upon the approach used by 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/ORpredicates, 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 for guides, examples, and more.
go get -u github.com/lrstanley/entrest@latest:raising_hand_man: Support & Assistance
- :heart: Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
- :raising_hand_man: Take a look at the support document on guidelines for tips on how to ask the right questions.
- :lady_beetle: For all features/bugs/issues/questions/etc, head over here.
:handshake: Contributing
- :heart: Please review the Code of Conduct for guidelines on ensuring everyone has the best experience interacting with the community.
- :clipboard: Please review the contributing 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.
:balance_scale: License
MIT License
Copyright (c) 2024 Liam Stanley <liam@liam.sh>
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