moai-domain-web-api
REST API and GraphQL design with OpenAPI 3.1, authentication, versioning, and rate limiting.
When & Why to Use This Skill
The moai-domain-web-api skill is a specialized toolkit designed for the professional architecture and implementation of REST and GraphQL APIs. By leveraging OpenAPI 3.1 standards, it streamlines the design process while enforcing critical production requirements such as secure authentication, semantic versioning, and rate limiting. It integrates TRUST 5 principles and Test-Driven Development (TDD) workflows to ensure that API infrastructures are not only functional but also scalable, secure, and maintainable according to 2025 industry benchmarks.
Use Cases
- Designing standardized RESTful and GraphQL API specifications using OpenAPI 3.1 to ensure seamless integration and documentation.
- Implementing robust security and traffic control measures, including multi-method authentication and rate-limiting policies for high-traffic endpoints.
- Managing API lifecycles through automated versioning and migration guidance to maintain backward compatibility and system stability.
- Conducting automated code reviews and quality gate checks to ensure API implementations adhere to TRUST 5 principles and maintain at least 85% test coverage.
- Troubleshooting and optimizing existing API designs by integrating modern tools like Postman and Swagger UI for real-time validation.
| name | moai-domain-web-api |
|---|---|
| version | 2.0.0 |
| created | 2025-10-22 |
| updated | 2025-10-22 |
| status | active |
| description | REST API and GraphQL design with OpenAPI 3.1, authentication, versioning, and rate limiting. |
| keywords | ['rest', 'graphql', 'openapi', 'api-design', 'authentication'] |
Domain Web Api Skill
Skill Metadata
| Field | Value |
|---|---|
| Skill Name | moai-domain-web-api |
| Version | 2.0.0 (2025-10-22) |
| Allowed tools | Read (read_file), Bash (terminal) |
| Auto-load | On demand when keywords detected |
| Tier | Domain |
What It Does
REST API and GraphQL design with OpenAPI 3.1, authentication, versioning, and rate limiting.
Key capabilities:
- ✅ Best practices enforcement for domain domain
- ✅ TRUST 5 principles integration
- ✅ Latest tool versions (2025-10-22)
- ✅ TDD workflow support
When to Use
Automatic triggers:
- Related code discussions and file patterns
- SPEC implementation (
/alfred:2-run) - Code review requests
Manual invocation:
- Review code for TRUST 5 compliance
- Design new features
- Troubleshoot issues
Tool Version Matrix (2025-10-22)
| Tool | Version | Purpose | Status |
|---|---|---|---|
| OpenAPI | 3.1.0 | Primary | ✅ Current |
| Postman | 11.21.0 | Primary | ✅ Current |
| Swagger UI | 5.18.2 | Primary | ✅ Current |
Inputs
- Language-specific source directories
- Configuration files
- Test suites and sample data
Outputs
- Test/lint execution plan
- TRUST 5 review checkpoints
- Migration guidance
Failure Modes
- When required tools are not installed
- When dependencies are missing
- When test coverage falls below 85%
Dependencies
- Access to project files via Read/Bash tools
- Integration with
moai-foundation-langsfor language detection - Integration with
moai-foundation-trustfor quality gates
References (Latest Documentation)
Documentation links updated 2025-10-22
Changelog
- v2.0.0 (2025-10-22): Major update with latest tool versions, comprehensive best practices, TRUST 5 integration
- v1.0.0 (2025-03-29): Initial Skill release
Works Well With
moai-foundation-trust(quality gates)moai-alfred-code-reviewer(code review)moai-essentials-debug(debugging support)
Best Practices
✅ DO:
- Follow domain best practices
- Use latest stable tool versions
- Maintain test coverage ≥85%
- Document all public APIs
❌ DON'T:
- Skip quality gates
- Use deprecated tools
- Ignore security warnings
- Mix testing frameworks