APIs
Si tu organismo publica datos mediante una API, es importante que el servicio resulte fácil de encontrar, comprender y utilizar.
Se recomienda:
- documentar claramente la API, sus operaciones y parámetros;
- incluir ejemplos de consultas y respuestas;
- describir las condiciones de uso del servicio;
- mantener una URL estable para la documentación;
- incorporar la URL de la documentación en el catálogo de datos abiertos del organismo, indicando que se trata de una API.
Recomendación
Siempre que sea posible, publicá también una versión descargable completa de los datos en formatos abiertos. Las APIs complementan a los archivos descargables, pero no los reemplazan.
Más información
Herramientas como OpenAPI, Read the Docs o MkDocs pueden facilitar la documentación y publicación de APIs.