Descripción del proyecto
TraducidoNuestra API REST ha crecido a más de cuarenta endpoints y, en este momento, ninguno de ellos está documentado. Los desarrolladores que se integran con nosotros están efectivamente revirtiendo la ingeniería de la API a partir de solicitudes de ejemplo, lo que ralentiza a todos y genera un flujo constante de preguntas de soporte evitables. Queremos solucionar eso adecuadamente encargando una especificación completa de OpenAPI 3.0 junto con un portal para desarrolladores pulido que la gente realmente pueda leer y probar.
Estamos buscando a alguien que combine una fuerte redacción técnica con experiencia práctica real en API, porque este trabajo se trata tanto de una explicación clara como de esquemas precisos. Producirás una especificación completa de OpenAPI 3.0 en YAML que cubra cada endpoint, sus esquemas de solicitud y respuesta y sus códigos de error, luego convertir eso en documentos interactivos alojados con Swagger UI o Redoc. Además de la referencia, necesitamos una guía de Inicio Rápido que explique la autenticación, límites de tasa, paginación y manejo de errores, además de ejemplos de código para copiar y pegar en cURL, PHP y JavaScript para cada endpoint principal. Completa con una colección de Postman y una plantilla de registro de cambios para el historial de versiones.
Proporcionaremos acceso a la API, nuestra documentación interna existente y la lista completa de endpoints; esperamos la documentación terminada dentro de veintiún días.
Entregables:
— 1. Especificación OpenAPI 3.0 en YAML — todos los endpoints, esquemas de solicitud/respuesta, códigos de error
— 2. Documentos API interactivos — página alojada en Swagger UI o Redoc
— 3. Guía de Inicio Rápido — autenticación, límites de tasa, paginación, errores
— 4. Ejemplos de código — cURL, PHP, JavaScript para cada endpoint principal
— 5. Registro de cambios — plantilla de historial de versiones
— 6. Exportación de colección de Postman
Proceso:
— Proporcionamos: acceso a la API, documentación de código existente, lista de endpoints
— Tú entregas: documentación completa en 21 días
— Se requiere fuerte redacción técnica más experiencia en API
Estamos buscando a alguien que combine una fuerte redacción técnica con experiencia práctica real en API, porque este trabajo se trata tanto de una explicación clara como de esquemas precisos. Producirás una especificación completa de OpenAPI 3.0 en YAML que cubra cada endpoint, sus esquemas de solicitud y respuesta y sus códigos de error, luego convertir eso en documentos interactivos alojados con Swagger UI o Redoc. Además de la referencia, necesitamos una guía de Inicio Rápido que explique la autenticación, límites de tasa, paginación y manejo de errores, además de ejemplos de código para copiar y pegar en cURL, PHP y JavaScript para cada endpoint principal. Completa con una colección de Postman y una plantilla de registro de cambios para el historial de versiones.
Proporcionaremos acceso a la API, nuestra documentación interna existente y la lista completa de endpoints; esperamos la documentación terminada dentro de veintiún días.
Entregables:
— 1. Especificación OpenAPI 3.0 en YAML — todos los endpoints, esquemas de solicitud/respuesta, códigos de error
— 2. Documentos API interactivos — página alojada en Swagger UI o Redoc
— 3. Guía de Inicio Rápido — autenticación, límites de tasa, paginación, errores
— 4. Ejemplos de código — cURL, PHP, JavaScript para cada endpoint principal
— 5. Registro de cambios — plantilla de historial de versiones
— 6. Exportación de colección de Postman
Proceso:
— Proporcionamos: acceso a la API, documentación de código existente, lista de endpoints
— Tú entregas: documentación completa en 21 días
— Se requiere fuerte redacción técnica más experiencia en API
Textos y traducción Efectivo, Transferencia bancaria
