# entrest

> entrest is an EntGo extension for generating compliant OpenAPI specs and HTTP handler implementations that match those specs.


- **Guides**
- [Getting Started](https://entrest.dev/guides/getting-started.md): A guide to getting started with entrest.
- [Calling Your New API](https://entrest.dev/guides/calling-your-new-api.md): Your app is setup, how do you call it?

- **Generating OpenAPI Specs**
- [Codegen Configuration](https://entrest.dev/openapi-specs/configuration.md): Generation-time options on entrest.Config that shape the OpenAPI spec.
- [Annotation Reference](https://entrest.dev/openapi-specs/annotation-reference.md)
- [Eager Loading](https://entrest.dev/openapi-specs/eager-loading.md)
- [Pagination](https://entrest.dev/openapi-specs/pagination.md)
- [Extending the Spec](https://entrest.dev/openapi-specs/extending.md)

- **HTTP Handler**
- [Mount the Handler](https://entrest.dev/http-handler/getting-started.md): Mount the generated HTTP handler and expose CRUD endpoints from your Ent schemas.
- [Runtime Configuration](https://entrest.dev/http-handler/configuration.md): Runtime configuration for the generated HTTP handler via rest.ServerConfig.
- [API Docs](https://entrest.dev/http-handler/api-docs.md): How to replace the embedded Scalar docs UI with your own OpenAPI viewer.
- [Testing](https://entrest.dev/http-handler/testing.md): Generated helpers for integration-testing the HTTP handler against a real Ent client.
- [Authentication & Permissions](https://entrest.dev/http-handler/auth-and-permissions.md): Wire authentication middleware and Ent privacy policies to the generated HTTP handler.

- **Resources**
- [Best Practices](https://entrest.dev/resources/best-practices.md): OpenAPI conventions entrest follows and how to keep generated specs useful for clients and validators.
- [Recommended Tools](https://entrest.dev/resources/recommended-tools.md): Tools for validating, diffing, and working with generated OpenAPI specs.
- [Troubleshooting](https://entrest.dev/resources/troubleshooting.md): Common codegen failures, runtime errors, and misconfiguration scenarios when using entrest.
- [Architecture](https://entrest.dev/resources/architecture.md): How entrest fits into Ent code generation — from schema annotations to OpenAPI spec and HTTP handler output.

## Optional

- [pkg.go.dev documentation](https://pkg.go.dev/github.com/lrstanley/entrest): Go package API reference on pkg.go.dev
- [EntGo documentation](https://entgo.io/docs/getting-started): official EntGo framework documentation