Conceção da API

Criar concepções de API bem pensadas que se alinhem com as necessidades do utilizador, os objectivos do produto e especificações consistentes.

Resultados

• Conceção de API bem documentada e coerente

Linhas de metrô relacionadas

• Linha de conceção API

Porque é importante

A conceção de APIs não se resume à nomeação de pontos de extremidade. Um bom design garante que as APIs sejam utilizáveis, consistentes e alinhadas com os objectivos comerciais e técnicos. APIs mal concebidas resultam em dívida técnica, fraca adoção e retrabalho entre equipas.

Critérios de entrada

• A arquitetura da API usa padrões que promovem a reutilização e a integração e é validada pelas partes interessadas.
• O objetivo da API é ocultar modelos de dados de back-end e discrepâncias.
• O design e os pontos finais da API têm uma conexão clara com seu valor comercial e recursos.
• A API tem um design consistente com nossos outros produtos API.

Critérios de saída

• A arquitetura da API usa padrões que promovem a reutilização e a integração e é validada pelas partes interessadas.
• O objetivo da API é ocultar modelos de dados de back-end e discrepâncias.
• O design e os pontos finais da API têm uma conexão clara com seu valor comercial e recursos.
• A API tem um design consistente com nossos outros produtos API.

Como funciona

1. Definir entidades principais, os seus atributos e relações para criar um entendimento concetual partilhado entre APIs.
   Domain Canvas Uma ferramenta de modelação para definir e comunicar as principais entidades e relações no seu domínio, assegurando a consistência semântica entre APIs.
2. 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.
   Interaction Canvas Definir interações API, fluxos de trabalho e respostas esperadas para garantir uma experiência consistente do consumidor API.
3. Aplicar padrões de conceção REST para criar contratos de API consistentes e reutilizáveis que são validados com as partes interessadas.
   REST Canvas Conceber APIs utilizando os princípios RESTful, definindo recursos, verbos e exemplos de pedidos e respostas.
4. Aplicar padrões de conceção orientados para eventos para criar contratos de API consistentes e reutilizáveis que são validados com as partes interessadas.
   Event Canvas Conceber APIs orientadas para eventos, definindo eventos, accionadores e lógica de processamento.
5. Aplicar padrões de design GraphQL para criar contratos de API consistentes e reutilizáveis que são validados com as partes interessadas.
   GraphQL Canvas Conceber APIs GraphQL definindo tipos, consultas, mutações e subscrições.
6. Utilizar as informações para conceber APIs que satisfaçam as necessidades dos consumidores, garantindo que são detectáveis, compreensíveis e utilizáveis.
   Princípios de conceção da API Um guia conciso para a usabilidade, descoberta e consistência da API, baseado em filosofias de design comprovadas e nas necessidades dos utilizadores.
7. Utilize a lista de verificação de auditoria da API para garantir que a conceção da API cumpre os requisitos funcionais e não funcionais, incluindo segurança, desempenho e conformidade.
   Lista de verificação de auditoria da API Uma lista de verificação abrangente para verificar a prontidão da API antes da publicação, abrangendo o design, a documentação, a segurança e a conformidade com a política.

Aplicar no seu trabalho

Fornecer modelos reutilizáveis, normas e ferramentas de validação para especificações de API. Assegurar que as equipas seguem as revisões de design e incorporam o feedback atempadamente.