README.md
README.md
Definição:
API é uma interface que possibilita interações através de um contrato (dados e protocolo) bem definido entre componentes e/ou produtos de softwares geralmente baseada em um modelo requisição/resposta.
O que significa API?
API significa Application Program Interface (Interface de Programação de Aplicativos). No contexto das APIs, a palavra Aplicativo se refere a qualquer software com uma função distinta. A interface pode ser considerada como um contrato de serviço entre dois aplicativos. Este contrato define como os dois se comunicam usando um modelo de requisição e resposta, que é detalhada na documentação da API.
Design
No Design de uma API devemos levar em consideração os Requisitos Funcionais (RF) e Requisitos Não Funcionais (RNF), tais como: segurança, confidencialidade, desempenho, disponibilidade, escalabilidade e tolerância a falha. Ainda é importante definir um formato de dados (JSON, XML, TXT e etc), estrutura e tipos de dados. Outro aspecto relevante é definição de endpoints e chaves que serão utilizadas pelos usuários (componentes e produtos de software).
API Fundamentos
Explana como as APIs funcionam, quais são as principais tecnologias e ainda como desenhar, desenvolver e documentar APIs.
Artefatos para Desenvolvimento de API. Artetados são conjuntos de documentos, especificações, modelos e orientações uteis para o desenvolvimento de um produto.
Boas Práticas de Design, Desenvolvimento e Documentação de API:
- Canvas API É uma ferramenta simples, visual, colaborativa que ajuda no Desing de APIs
- OpenAPI é um padrão para design, desenvolvimento e documentação de API
- Code First e Design First São abordagens para Design e Desenvolvimento de API
- O API Stylebook contém diretrizes internas de design de API compartilhadas com a comunidade por algumas empresas e agências governamentais conhecidas.
- Swagger é um projeto usado para descrever e documentar APIs.
Report é documento que demostra como a tecnologia está sendo utilizada, ele traz números, gráficos e informações relevantes:
Postman´s State of the API 2022 report