OpenAPI¶
A especificação OpenAPI descreve de forma estruturada as operações, parâmetros, respostas e recursos disponibilizados pelo serviço.
Especificação machine-readable¶
https://ogcapi.dgterritorio.gov.pt/openapi
Documentação interactiva¶
https://ogcapi.dgterritorio.gov.pt/openapi?f=html
Utilização¶
A especificação pode ser utilizada para:
- conhecer os endpoints;
- identificar parâmetros;
- verificar respostas e formatos;
- gerar clientes;
- validar integrações;
- automatizar testes;
- documentar aplicações.
Recomendação
Para integrações duradouras, utilize apenas operações e parâmetros documentados no OpenAPI. Evite depender de comportamentos não documentados.