Diseñe su API con su audiencia en mente. Documente los requisitos y supuestos por adelantado. Proporcione ejemplos para casos de uso comunes (más que solo una muestra de juguete). Una API bien diseñada debería requerir una documentación mínima; la API debería explicarse en gran medida por sí misma. Pruebe su documentación tal como prueba el código; defina casos de prueba y exponga la API y los documentos a desarrolladores de varios tipos y niveles de experiencia. Refinar y refactorizar según sea necesario; pretenden crear el conjunto mínimo de documentación para cubrir adecuadamente el código y las audiencias primarias. Si es necesario, considere reescribir las funciones de la API para mayor claridad. Sea coherente en la denominación, la redacción y el estilo del código API, ejemplos y documentación.
El método y el estilo exactos de la documentación son mucho menos importantes que las pautas anteriores.
- ¿Cuánto ganan ustedes haciendo trabajo independiente en Upwork en desarrollo web?
- ¿Cuál es el lenguaje de programación web más seguro para diseñar un sitio web que acepte pagos de créditos?
- Usabilidad: ¿Por qué los sitios web utilizan menús desplegables inutilizables para la selección de años?
- ¿Cuáles son los componentes de los servicios web?
- ¿Qué necesito para ser aceptado en Canadá como desarrollador web?
