此页面暂无简体中文版本,现以英文显示。
Where the developer docs live
The reference pages on every server, the developer and marketplace documents in the repository, and working examples of every package type.
| What | Where |
|---|---|
| API reference page (every endpoint, scope, convention) | /api/v1/docs on every server; /api/docs on the hosted platform shows the same page |
| Machine-readable spec (OpenAPI 3.1) | /api/v1/openapi.json |
| OAuth discovery (RFC 8414) | /.well-known/oauth-authorization-server |
| REST API and webhooks guide | docs/API.md |
| Plugin authoring reference (manifest, hooks, filters, widgets, security, worked example) | docs/PLUGIN-DEVELOPER-GUIDE.md |
| Plugin package format and install pipeline | docs/PLUGINS.md |
| Built-in modules: export → edit → import | docs/MODULES.md |
| Marketplace developer docs: which type to build, index of the specs | docs/DEVELOPERS/README.md |
| Selling: seller account, uploads, automated checks, review, payouts, refunds | docs/DEVELOPERS/SUBMISSION-GUIDE.md |
| Package specs | docs/DEVELOPERS/PLUGIN-SDK.md, THEME-SPEC.md, WIDGET-SPEC.md, TEMPLATES-SPEC.md, INTEGRATION-SPEC.md |
| How the marketplace works (trust model, billing, install per type) | docs/MARKETPLACE.md |
| Working examples, one per listing type | examples/marketplace/ (plugin-booking-pulse, theme-harbor, widget-feature-cards, widget-countdown, industry-bike-leasing, document-clean-invoice, integration-hello-sync) |
| Self-hosted reference plugin and manifest template | modules/example-checklist/, modules/_templates/module.json |
The reference page and the OpenAPI document are generated from one table (OPS in src/lib/integrations/openapi.ts), and a check script compares that table with the real routers — so the page matches the server you are looking at.
curl -s https://your-workspace.zmle.com/api/v1/openapi.json -o zmle-openapi.jsonnpm run check:marketplace -- --pure # the same package checks the developer portal runs, no databaseWritten from: src/lib/api-v1/docs.ts, src/lib/integrations/openapi.ts, src/app/.well-known/oauth-authorization-server/route.ts, docs/API.md, docs/MODULES.md, docs/DEVELOPERS/README.md, docs/DEVELOPERS/SUBMISSION-GUIDE.md, docs/MARKETPLACE.md, examples/marketplace/theme-harbor/theme.json, scripts/marketplace-check.ts