Service management

A service is one generated backend and its platform resources. It contains the schema, generated framework code, extensions, API documentation, credentials, environment variables, deployment history, and database access for one application boundary.

Create a service

Service builder

Open Apso Cloud and select a workspace.
Create a service.
Describe the backend or select a starter model.
Review the proposed entities and relationships in the schema editor.
Generate the code before adding product-specific behavior.

Select the starter closest to the first complete product workflow. For a multi-tenant SaaS, begin with workspaces and memberships. For a CRM, begin with contacts, companies, deals, and activities. Remove unused entities before generation.

CLI

Create and link a service in an authenticated workspace:


apso login
apso use your-workspace-slug
apso init --name project-api --language typescript
cd project-api

Create a local-only project when deployment can wait:


apso init --name project-api --language typescript --skip-platform
cd project-api

Link that project later:


apso link --workspace your-team --create project-api

Work with the service

Use .apsorc as the reviewable contract for the generated backend:


apso schema validate
apso generate
apso dev

After the service starts, inspect /_docs, create one record, and read it back. This verifies the schema and HTTP surface before frontend work begins.

Generated and owned code

Path	Responsibility
`.apsorc`	Define entities, fields, relationships, language, auth, and generation settings.
`src/autogen/`	Inspect generated framework layers. Regeneration can replace these files.
`src/extensions/`	Implement custom endpoints, hooks, integrations, and business rules.
migrations	Review and commit database changes created from the schema.
tests	Protect generated behavior and product-specific extensions.

The repository remains useful outside Apso Cloud. It contains standard NestJS, FastAPI, or Gin source code that your team can run and deploy with the framework’s normal tooling.

Platform views

Use the service navigation to move through the operational surfaces available for the selected plan:

View	Use
Editor	Review and change service code and local `.env` configuration.
Data	Inspect generated resources after creating an API key.
API Keys	Create, deactivate, and revoke service credentials.
Docs	Inspect OpenAPI and exercise requests with a selected key.
Environment	Configure variables for a deployed hosted service.
Logs	Diagnose generation and deployment behavior.
Settings	Review service identity, plan capabilities, repository, and domain settings.

Some views depend on the service plan and deployment mode. Self-hosted services keep operational configuration in their own infrastructure.

Deploy a linked service


apso github connect
apso migrate
apso deploy

The deploy command checks migrations, synchronizes code to the connected repository, triggers the build, and waits for completion. Use apso status and apso logs when a build needs investigation.

Service design guidance

Keep entities together when they share transactions and change together.
Split services when teams need independent deployments or data ownership.
Put tenant scope in the initial schema for multi-tenant products.
Keep server credentials out of browser and mobile bundles.
Review generated diffs and migrations in version control.

Choose a product-shaped schema before starting from a blank service

Starter backends

Separate local, hosted, and frontend configuration

Environment variables

Create and rotate server-side access credentials

API keys