Importância da documentação e o que é Open API

Quando um programador desenvolve um código é importante lembrar que outros desenvolvedores e os usuários vão utilizá-lo. Por esse motivo, a documentação técnica é tão importante, pois ela auxiliará no entendimento do código e no funcionamento da aplicação.

Padrão Open API

Open API é uma iniciativa de diversas empresas em criar um padrão de documentação de API. Esse padrão facilita a comunicação de diversos serviços de empresas diferentes, facilitando o intercâmbio de informações.

Por ser open source, é possível visitar a especificação desse padrão no GitHub clicando aqui.

Por fim, para visualizar a API documentada, será utilizada a ferramenta Swagger Petstore.