# Conceção de contratos - Definir contratos de interface da API claros

Canonical page: https://apiopscycles.com/pt/stations/contract-design

Language: pt

Entity ID: contract-design

## Description

Criar contratos de interface da API claros e bem definidos que descrevam as expectativas, responsabilidades e diretrizes de utilização.

## Why it matters

Os contratos de interface da API são essenciais para garantir a clareza e o alinhamento entre os fornecedores e os consumidores de API. Esta estação fornece diretrizes para a conceção de contratos de interface da API que sejam claros, abrangentes e fáceis de compreender.

## Apply in work

Fornecer modelos de design de contratos, formatos normalizados e processos de revisão. Assegurar que as equipas criam contratos de interface da API claros e bem definidos que descrevem as expectativas, responsabilidades e diretrizes de utilização.

## Outcomes

- Contratos de interface da API claros definidos para cada API
- Expectativas e responsabilidades definidas para os fornecedores e consumidores de API
- Orientações de utilização e boas práticas documentadas
- Redução de mal-entendidos e litígios sobre a utilização da API

## Steps

1. Definir contratos de interface da API que descrevam as expectativas, responsabilidades e diretrizes de utilização para cada API.
2. Utilizar formatos normalizados (por exemplo, OpenAPI, AsyncAPI) para criar contratos de interface da API legíveis por máquina que sejam fáceis de partilhar e validar.
3. Assegurar que os contratos de interface da API são revistos e aprovados pelas partes interessadas para garantir o alinhamento e a clareza. — [Lista de verificação de auditoria da API](https://apiopscycles.com/pt/resources/api-audit-checklist.md)

## Questions

- Definir contratos de interface da API que descrevam as expectativas, responsabilidades e diretrizes de utilização para cada API.
- Utilizar formatos normalizados (por exemplo, OpenAPI, AsyncAPI) para criar contratos de interface da API legíveis por máquina que sejam fáceis de partilhar e validar.
- Assegurar que os contratos de interface da API são revistos e aprovados pelas partes interessadas para garantir o alinhamento e a clareza.
- Fornecer modelos de design de contratos, formatos normalizados e processos de revisão. Assegurar que as equipas criam contratos de interface da API claros e bem definidos que descrevem as expectativas, responsabilidades e diretrizes de utilização.
- Os contratos de interface da API são essenciais para garantir a clareza e o alinhamento entre os fornecedores e os consumidores de API. Esta estação fornece diretrizes para a conceção de contratos de interface da API que sejam claros, abrangentes e fáceis de compreender.

## Resources

- [Lista de verificação de auditoria da API](https://apiopscycles.com/pt/resources/api-audit-checklist.md)