lmiranda
2d51df7a42
Phase 1b: Rename all ~94 commands across 12 plugins to /<noun> <action> sub-command pattern. Git-flow consolidated from 8→5 commands (commit variants absorbed into --push/--merge/--sync flags). Dispatch files, name: frontmatter, and cross-reference updates for all plugins. Phase 2: Design documents for 8 new plugins in docs/designs/. Phase 3: Scaffold 8 new plugins — saas-api-platform, saas-db-migrate, saas-react-platform, saas-test-pilot, data-seed, ops-release-manager, ops-deploy-pipeline, debug-mcp. Each with plugin.json, commands, agents, skills, README, and claude-md-integration. Marketplace grows from 12→20. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
# saas-api-platform Plugin - CLAUDE.md Integration
|
|
|
|
Add this section to your project's CLAUDE.md to enable saas-api-platform plugin features.
|
|
|
|
## Suggested CLAUDE.md Section
|
|
|
|
```markdown
|
|
## API Platform Integration
|
|
|
|
This project uses the saas-api-platform plugin for API development workflows.
|
|
|
|
### Configuration
|
|
|
|
Run `/api setup` to auto-detect framework and configure project paths.
|
|
Settings stored in `.api-platform.json` in project root.
|
|
|
|
### Available Commands
|
|
|
|
| Command | Purpose |
|
|
|---------|---------|
|
|
| `/api setup` | Detect framework and configure project |
|
|
| `/api scaffold <resource>` | Generate CRUD routes, models, schemas |
|
|
| `/api validate` | Check routes against OpenAPI spec |
|
|
| `/api docs` | Generate/update OpenAPI specification |
|
|
| `/api test-routes` | Generate endpoint test cases |
|
|
| `/api middleware <type>` | Add auth, CORS, rate-limit, logging |
|
|
|
|
### When to Use
|
|
|
|
- **Starting a new resource**: `/api scaffold orders` generates routes, models, and registers the router
|
|
- **Before PR/deploy**: `/api validate` ensures spec and code are in sync
|
|
- **After route changes**: `/api docs --update` refreshes the OpenAPI spec
|
|
- **Adding infrastructure**: `/api middleware auth` adds JWT authentication
|
|
- **Before release**: `/api test-routes --coverage=full` generates comprehensive tests
|
|
|
|
### Conventions
|
|
|
|
- All routes follow RESTful naming (plural nouns, no verbs in paths)
|
|
- Versioning via URL prefix (`/v1/`) when configured
|
|
- Pagination on all list endpoints (page, page_size parameters)
|
|
- Consistent error response format with error codes and request IDs
|
|
```
|
|
|
|
## Typical Workflows
|
|
|
|
### New Resource
|
|
```
|
|
/api scaffold products
|
|
/api docs --update
|
|
/api test-routes products
|
|
/api validate
|
|
```
|
|
|
|
### Add Authentication
|
|
```
|
|
/api middleware add auth
|
|
/api validate --strict
|
|
```
|
|
|
|
### Pre-Release Check
|
|
```
|
|
/api validate --strict
|
|
/api test-routes --coverage=full
|
|
```
|