II.
LibraryProcess overview
Reference · livelib-process:software-architecture--api-design-specification
api-design-specification overview
API Design and Specification - Comprehensive API design process covering REST/GraphQL/gRPC APIs, including specification, documentation, contract definition, design patterns, security, versioning, and developer experience with industry best practices and quality gates.
Attributes
displayName
api-design-specification
description
API Design and Specification - Comprehensive API design process covering REST/GraphQL/gRPC APIs,
including specification, documentation, contract definition, design patterns, security, versioning, and developer experience
with industry best practices and quality gates.
libraryPath
library/specializations/software-architecture/api-design-specification.js
specialization
software-architecture
references
- - REST API Best Practices: https://restfulapi.net/ - OpenAPI Specification: https://swagger.io/specification/ - GraphQL Spec: https://spec.graphql.org/ - API Design Patterns: https://microservice-api-patterns.org/ - Google API Design Guide: https://cloud.google.com/apis/design - Microsoft REST API Guidelines: https://github.com/microsoft/api-guidelines
example
const result = await orchestrate('specializations/software-architecture/api-design-specification', {
projectName: 'E-Commerce Platform API',
apiType: 'REST',
apiPurpose: 'Public API for third-party integrations',
targetAudience: 'external-developers',
constraints: {
latency: '< 200ms p95',
authentication: 'OAuth2',
rateLimit: '1000 req/min',
versioning: 'URL-based'
}
});
usesAgents
- openapi-generator
- c4-diagram-generator
- threat-modeler
- api-gateway-config
- openapi-validator
- swagger-ui-deployer
- api-mock-server
- api-design-architect
Outgoing edges
lib_applies_to_domain1
- domain:software-engineering·DomainSoftware Engineering
lib_belongs_to_specialization1
- specialization:software-architecture·Specialization
lib_covers_topic2
- topic:api-design·TopicAPI Design
- topic:rest·TopicREST
lib_implements_workflow1
- workflow:api-design-review·WorkflowAPI Design Review
lib_involves_role2
- role:architect·RoleArchitect
- role:backend-engineer·RoleBackend Engineer
lib_requires_skill_area2
- skill-area:backend-api-design·SkillAreaBackend API Design
- skill-area:api-design·SkillAreaAPI Design
uses_agent2
- lib-agent:software-architecture--threat-modeler·LibraryAgentthreat-modeler
- lib-agent:software-architecture--api-design-architect·LibraryAgentapi-design-architect
Incoming edges
None.