# Designer API

Canonical page: https://apiopscycles.com/pt/roles/api-designer

Language: pt

Entity ID: api-designer

Modela o contrato de interface, o modelo de interação, a consistência e a usabilidade das capacidades expostas.

## Decisions

- Definir entidades principais, os seus atributos e relações para criar um entendimento concetual partilhado entre APIs.
- Utilize o Canvas de Interação para definir a forma como os consumidores irão interagir com a API, garantindo que esta satisfaz as suas necessidades e expectativas.
- Aplicar padrões de conceção REST para criar contratos de interface da API consistentes e reutilizáveis que são validados com as partes interessadas.
- Aplicar padrões de conceção orientados para eventos para criar contratos de interface da API consistentes e reutilizáveis que são validados com as partes interessadas.
- Aplicar padrões de conceção GraphQL para criar contratos de interface da API consistentes e reutilizáveis que são validados com as partes interessadas.
- Utilize os princípios de projeto e o guia de estilo da API para alinhar suas decisões de projeto com regras compartilhadas e permitir uma validação de auditoria consistente.

## Outputs

- Conceção de API bem documentada e coerente
- Contratos de interface da API reutilizáveis e validados
- Desenhos alinhados com modelos de domínio e padrões de interação
- Rastreabilidade da conceção ao valor de negócio
- spec
- contract
- design-artifact
- documentation

## Recommended resources

- [Canvas de Domínio](https://apiopscycles.com/pt/resources/domain-canvas.md)
- [Canvas de desenho da solução da capacidade](https://apiopscycles.com/pt/resources/capability-solution-design-canvas.md)
- [Canvas de Interação](https://apiopscycles.com/pt/resources/interaction-canvas.md)
- [Canvas de prontidão e operações da capacidade](https://apiopscycles.com/pt/resources/capability-readiness-operations-canvas.md)

## Participation by cycle and station

- [Ciclo de Produto de Capacidades](https://apiopscycles.com/pt/cycles/capability-productization-cycle.md) / [Desenho da solução e interação da capacidade](https://apiopscycles.com/pt/cycles/capability-productization-cycle/stations/api-design.md): lead
- [Ciclo de Produto de Capacidades](https://apiopscycles.com/pt/cycles/capability-productization-cycle.md) / [Entrega e operações da capacidade](https://apiopscycles.com/pt/cycles/capability-productization-cycle/stations/api-delivery.md): consulted
- [Ciclo de Produto de Capacidades](https://apiopscycles.com/pt/cycles/capability-productization-cycle.md) / [Garantia de prontidão da capacidade](https://apiopscycles.com/pt/cycles/capability-productization-cycle/stations/api-audit.md): consulted
- [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle.md) / [Experiência do consumidor da API](https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-consumer-experience.md): consulted
- [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle.md) / [Conceção da API](https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-design.md): lead
- [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle.md) / [Entrega da API](https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-delivery.md): core
- [Ciclo de Produto de API](https://apiopscycles.com/pt/cycles/api-productization-cycle.md) / [Auditoria da API](https://apiopscycles.com/pt/cycles/api-productization-cycle/stations/api-audit.md): core
- [Ciclo de Produto de Integração](https://apiopscycles.com/pt/cycles/integration-productization-cycle.md) / [Conceção da solução de integração](https://apiopscycles.com/pt/cycles/integration-productization-cycle/stations/api-design.md): core
- [Ciclo de Produto de Integração](https://apiopscycles.com/pt/cycles/integration-productization-cycle.md) / [Entrega e operações da integração](https://apiopscycles.com/pt/cycles/integration-productization-cycle/stations/api-delivery.md): consulted