Descripción del proyecto
TraducidoNuestra API REST ha crecido a más de cuarenta puntos finales, y ninguno de ellos está documentado hoy. Los desarrolladores que se integran con nosotros esencialmente invierten la lógica de la API a partir de ejemplos de solicitudes; esto ralentiza las cosas y crea una avalancha de preguntas de soporte. Queremos resolver este problema a fondo y encargar una especificación completa de OpenAPI 3.0 junto con un portal del desarrollador pulido donde la documentación pueda ser leída y probada en vivo.
Necesitamos un ejecutor que combine una fuerte redacción técnica con experiencia real en API, porque la tarea se trata tanto de una explicación clara como de esquemas precisos. Necesitamos preparar una especificación completa de YAML OpenAPI 3.0 para todos los puntos finales, con esquemas de solicitud y respuesta y códigos de error, y luego convertirlo en documentación interactiva en Swagger UI o Redoc. Además de la referencia, necesitamos una guía de Inicio Rápido que cubra autenticación, límites de tasa, paginación y manejo de errores, además de ejemplos de código listos en cURL, PHP y JavaScript para cada punto final clave. Una colección de Postman y una plantilla de registro de cambios completan el panorama.
Proporcionamos acceso a la API, documentación interna del código y una lista completa de puntos finales; esperamos documentación terminada en 21 días.
Resultado:
— 1. Especificación YAML de OpenAPI 3.0 — todos los puntos finales, esquemas de solicitud/respuesta, códigos de error
— 2. Documentación interactiva (Swagger UI o Redoc)
— 3. Inicio Rápido — autenticación, límites, paginación, errores
— 4. Ejemplos de código — cURL, PHP, JS para cada punto final clave
— 5. Plantilla de registro de cambios
— 6. Colección de Postman
Proceso:
— Proporcionamos: acceso a la API, documentación del código, lista de puntos finales
— Tú: documentación completa en 21 días
Necesitamos un ejecutor que combine una fuerte redacción técnica con experiencia real en API, porque la tarea se trata tanto de una explicación clara como de esquemas precisos. Necesitamos preparar una especificación completa de YAML OpenAPI 3.0 para todos los puntos finales, con esquemas de solicitud y respuesta y códigos de error, y luego convertirlo en documentación interactiva en Swagger UI o Redoc. Además de la referencia, necesitamos una guía de Inicio Rápido que cubra autenticación, límites de tasa, paginación y manejo de errores, además de ejemplos de código listos en cURL, PHP y JavaScript para cada punto final clave. Una colección de Postman y una plantilla de registro de cambios completan el panorama.
Proporcionamos acceso a la API, documentación interna del código y una lista completa de puntos finales; esperamos documentación terminada en 21 días.
Resultado:
— 1. Especificación YAML de OpenAPI 3.0 — todos los puntos finales, esquemas de solicitud/respuesta, códigos de error
— 2. Documentación interactiva (Swagger UI o Redoc)
— 3. Inicio Rápido — autenticación, límites, paginación, errores
— 4. Ejemplos de código — cURL, PHP, JS para cada punto final clave
— 5. Plantilla de registro de cambios
— 6. Colección de Postman
Proceso:
— Proporcionamos: acceso a la API, documentación del código, lista de puntos finales
— Tú: documentación completa en 21 días
Textos y traducción Efectivo, Transferencia bancaria
