steedos-graphql-api

Generate a GraphQL CRUD API from Steedos object metadata.

1.6k|413|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-graphql-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: steedos-graphql-api
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-graphql-api
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-graphql-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Steedos GraphQL API auto-generates CRUD GraphQL schema from object metadata, eliminating manual schema maintenance and keeping API surface synchronized with data models.

Core Features & Use Cases

  • Auto-generated queries and mutations for every Steedos object: {object}, {object}__findOne, {object}__count, {object}__insert, {object}__update, {object}__delete.
  • Support for advanced lookups and data presentation: __expand, _display, _permissions, and related* branches to fetch related data and permissions in a single request.
  • DataLoader batching and authentication at the /graphql endpoint to enable scalable, secure access across multi-object workflows.

Quick Start

Query the GraphQL API by sending a POST to /graphql with a valid Authorization header.

Frequently Asked Questions about steedos-graphql-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate a GraphQL API from object metadata?▼

To auto-generate a GraphQL API from object metadata, use the Steedos platform to dynamically create CRUD queries and mutations for every object without manually defining a schema. It synchronizes your API surface directly with your data models.

How do I query related data and permissions in a single GraphQL request?▼

To query related data and permissions in a single GraphQL request, use the Steedos GraphQL API branches like __expand, _display, _permissions, and _related_*. These advanced lookups fetch associated records and access rights together efficiently.

Can I use DataLoader batching with my Steedos GraphQL API?▼

Yes, you can use DataLoader batching with the Steedos GraphQL API. It natively integrates DataLoader batching at the /graphql endpoint to enable scalable and secure access across complex multi-object workflows without N+1 query issues.

What GraphQL operations are supported for Steedos objects?▼

Supported GraphQL operations for Steedos objects include standard queries, findOne, count, insert, update, and delete mutations. It also supports dynamic object-level queries with filters, pagination, formatting, and secure authentication.

Does the Steedos GraphQL API require manual schema maintenance?▼

No, the Steedos GraphQL API does not require manual schema maintenance. It auto-generates the CRUD GraphQL schema directly from object metadata, eliminating manual updates and keeping the API surface synchronized with your data models.