Prisma GraphQL API
Every Prisma service exposes a GraphQL API with CRUD and realtime operations for the types defined in the service's datamodel. The GraphQL schema defining the types and operations of the Prisma GraphQL API is automatically generated based on the datamodel.
The Prisma GraphQL API is typically not consumed directly by a frontend/mobile application, but instead it's consumed through the Prisma client in a web application server to implement a GraphQL or REST API and interface with the database.
There are still some use cases where it can be appropriate to consume the Prisma API directly:
- Prototyping: While you're still in the validation phase of an application, using the Prisma API directly notably speeds up your development. When going into production, it's recommended to use Prisma as the ORM-layer in your app.
- Internal tooling & public APIs: If your API doesn't have any requirements for access permissions, no business logic is required, it might be a valid option to expose the Prisma API directly to client applications.
- Learning: If you want to learn how GraphQL is consumed from the frontend (e.g. using Apollo Client), you can consume the Prisma API directly without the need to add an additional web server layer on top.
This chapter explains everything you need to know about the Prisma GraphQL API and how it can be used in various contexts.
Reference
| Page | Description |
|---|---|
| Concepts | Learn about the most important API concepts such as batching, Relay connections, transactions, cascading deletes, .. |
| Authentication | Learn how to protect your Prisma API using the service secret |
| Queries | Learn about the auto-generated queries in the Prisma API |
| Mutations | Learn about the auto-generated mutations in the Prisma API |
| Subscriptions | Learn about the auto-generated subscriptions in the Prisma API |
| Error Handling | Learn how Prisma deals with errors in API requests |
Usage
| Page | Description |
|---|---|
| Using the Prisma GraphQL API | Learn about various ways to consume the Prisma GraphQL API |
Prisma Bindings
| Page | Description |
|---|---|
| Overview | Learn what Prisma bindings are and how they can be used to build GraphQL servers |
| Reference | API reference for Prisma bindings |