Para desarrollar una buena API, debe tener en cuenta los siguientes aspectos:
- Caso de uso / escenario
¿Cuál es el caso de uso de la API? Si es un pago, debe tener puntos finales apropiados que puedan manipular (recuperar, actualizar, eliminar) los recursos.
Por ejemplo: la API de pago debe proporcionar puntos finales para las transacciones de cobro, consulta y reembolso.
- Tecnología
REST se ha convertido en el estándar de facto para la mayoría de las API amigables para desarrolladores. REST con respuesta consistente ya que JSON es el más preferido ya que pueden ser consumidos por muchos clientes diferentes.
- ¿Cómo debería uno comenzar su objetivo de convertirse en ingeniero de software y trabajar en las principales empresas tecnológicas como Google?
- ¿Cuánto gana una persona que se especializa en ciencias de la computación en la universidad? ¿Qué hace una persona que se especializa en ingeniería de software?
- ¿Cuál es la diferencia entre refactoring y reingeniería?
- Cómo desarrollar un sitio web de seguridad total que no pueda ser hackeado por nadie
- ¿Cuáles son algunas buenas herramientas automatizadas de ingeniería de software?
Junto con esto, también debe analizar el aspecto del servidor de las API.
Si desea lograr un mayor rendimiento, es posible que desee buscar servidores de aplicaciones controlados por eventos (que proporcionan E / S sin bloqueo).
Dependiendo del lenguaje de implementación, debería poder obtener uno.
Ejemplo: Java tiene Netty, node.js (en JavaScript). Debería poder encontrar otros similares para Ruby, Python también.
- Facilidad de consumo
Este es el aspecto más importante que hace que el desarrollador de API sea amigable. Su API debe cumplir con los nombres consistentes (tanto puntos finales como parámetros) y debe ser detallada en la documentación junto con los ejemplos.
- SDK / Complementos
El siguiente aspecto de que la API sea amigable para el desarrollador es que proporcione SDK / Plugins en varios idiomas para que configurar y consumir sus API sean solo unas pocas líneas de código, que también se proporcionan en su documentación y las que funcionan perfectamente en el primer intento.
Todavía tengo preguntas, eche un vistazo a la documentación de API de Stripe
Tienen una de las API de pago más amigables para los desarrolladores.