Documentación de APIDocumentación técnica

Documentación de API a partir de las descripciones de sus endpoints

Entrega desde 1 díaCambios incluidosControl de calidad
Paquetes
Protección de pagoDetalles
  • Los cambios dentro del paquete son gratuitos.
  • Si no responde en los 3 días siguientes a la entrega, el trabajo se acepta automáticamente.
Hacer pedido · 39 US$

El dinero queda reservado al pagar y solo se libera cuando usted acepta el trabajo.

Documentación de API a partir de las descripciones de sus endpoints

Ejemplo de resultado

Ejemplo del paquete Estándar

Conjunto de procedimientos: apertura y cierre de una pequeña cafetería

PO-02: Cierre de la cafetería

ObjetivoDejar la cafetería limpia, segura y lista para el turno de mañana
QuiénEl barista de cierre; firma el encargado de turno
CuándoEmpezar a las 17:30, puerta cerrada a las 18:00, terminar a las 18:45
NecesitasHoja de control de cierre, llave de la caja, cubo de limpieza, paños azules

Antes de empezar

Atención: nunca apagues el interruptor general. Las neveras y la alarma están en el mismo cuadro.

Pasos

  1. A las 17:30, gira el cartel de la puerta a «Últimos pedidos». Los clientes que ya están dentro pueden quedarse hasta las 18:00.
  2. Pon la cafetera en modo enjuague. Mantén pulsado el botón de taza 5 segundos. Debes ver: «RINSE» parpadeando en la pantalla y agua caliente saliendo por los dos grupos durante unos 2 minutos.
  3. Saca los portafiltros y déjalos en remojo en el recipiente negro con una pastilla de limpieza durante 20 minutos.
  4. Pasa las tortas y los sándwiches a la nevera del fondo. Etiqueta todo lo abierto hoy con la fecha y «Consumir mañana».
  5. Anota las temperaturas de las neveras en la hoja de registro. Debes ver: entre 1 °C y 5 °C. Si una nevera marca más de 5 °C, ve primero al paso 12.
  6. A las 18:00, cierra con llave la puerta principal y gira el cartel a «Cerrado».
  7. Cierra la caja. Pulsa MENÚ, luego «Fin del día» y después «Informe Z». Debes ver: el informe imprimiéndose con el total del día. No cuentes el efectivo en el mostrador; lleva el cajón a la oficina.

(Pasos 8–14: suelos, basura, alarma y nota de traspaso).

Si algo sale mal

ProblemaQué hacer
Nevera por encima de 5 °CPasa la comida a la segunda nevera, anota la hora y la temperatura, avisa al encargado
El informe Z no se imprimeCambia el rollo de papel; si sigue sin salir, anota el total de la pantalla y hazle una foto
La alarma no se activaComprueba que la puerta trasera esté bien cerrada; con ella abierta no se arma

Firma

Barista de cierre: nombre, hora. Encargado de turno: iniciales.

Última revisión: [fecha]. Volver a revisar cuando se cambie la cafetera o la caja.

Cliente: Café Campanilla, 22 plazas, 7 empleados con turnos rotativos Material: notas de voz de la dueña, una lista de control escrita a mano y 9 fotos del mostrador, la cafetera y la pantalla de la caja Entregado: 6 procedimientos operativos (4.600 palabras): apertura, cierre, manejo de efectivo, registro de temperatura de las neveras, limpieza a fondo de la cafetera y atención de quejas. Abajo, un extracto del cierre.

El cliente y todos los datos son ficticios.

Acerca de este servicio

Los desarrolladores juzgan una API por su documentación en cuestión de minutos: si la autenticación o la primera solicitud no funcionan, se van. Escribimos la referencia y las guías de la API a partir de las descripciones de sus endpoints, su archivo OpenAPI o ejemplos de código: autenticación, URL base, cada endpoint con sus parámetros, ejemplos de solicitud y respuesta, códigos de error, límites de frecuencia y paginación. Un inicio rápido muestra la primera llamada correcta en pocos pasos.

Qué incluye

  • Qué recibeDocumentación de API en Markdown con bloques de código, lista para ReadMe, GitBook, Docusaurus o su repositorio. Escribimos a partir de lo que nos envía y no llamamos a su API.
  • Inicio rápidoDe la clave de API a la primera llamada
  • Referencia de endpointsParámetros, tipos, ejemplos
  • Errores y límitesCódigos, significados, consejos para reintentar
  • Ejemplos de códigocURL más un lenguaje que elija
  • Términos coherentesLos mismos nombres que en su esquema

Cómo funciona

  1. 1
    BriefUsted pega o adjunta los endpoints y los ejemplos
  2. 2
    Estructura y redacciónEscribimos la referencia y las guías
  3. 3
    EntregaRecibe Markdown listo para publicar

Qué necesitamos de usted

Las descripciones de los endpoints o un archivo de OpenAPI o Postman pegado como texto, los detalles de autenticación, ejemplos de solicitudes y respuestas, los códigos de error y quiénes son los usuarios de su API.

Le preguntaremos:

  • ¿Qué hace la API y quién la usa?
  • ¿Cómo funciona la autenticación?
  • ¿Qué lenguaje deben usar los ejemplos de código además de cURL?
  • ¿Dónde se publicará la documentación?

Comparar paquetes

PaquetesBásicoInicio rápido y hasta 5 endpoints19 US$EstándarHasta 20 endpoints con guías39 US$PremiumHasta 50 endpoints, documentación completa79 US$
Plazo1 día3 días5 días
Cambios123
Extensiónhasta 2.000 palabrashasta 6.000 palabrashasta 14.000 palabras
Endpointshasta 5hasta 20hasta 50
Lenguajes de los ejemplos de códigocURLcURL + 1cURL + 2
Hacer pedido BásicoHacer pedido EstándarHacer pedido Premium

Protección de pago

Usted paga al hacer el pedido, pero el dinero solo se libera por un trabajo aceptado.

  • Precio fijoEl precio del paquete no cambia después del pago.
  • El dinero queda reservadoAl pagar, el importe solo queda reservado. Pasa a Dleex cuando usted acepta el trabajo.
  • Revisado antes de la entregaCada resultado pasa un control de calidad antes de llegar a usted, y lo ve en la página del pedido antes de aceptarlo.
  • Cambios gratuitosSolicite cambios dentro de su brief tantas veces como permita el paquete.
  • Aceptación a los 3 díasSi en los 3 días siguientes a la entrega no acepta el trabajo ni solicita cambios, se acepta automáticamente. Si escribe en el chat del pedido después de la entrega, el pedido queda en espera; cuando le respondamos, podremos reiniciar el plazo de 3 días y se lo indicaremos en el chat.
  • Rehacer el trabajo o reembolso totalSi el resultado no se ajusta a su brief y los cambios no lo resolvieron, o el trabajo tarda más del doble de su plazo, escriba en el chat del pedido: rehacemos el trabajo o le reembolsamos el pago íntegro.
Cómo funciona →

Preguntas y respuestas

¿Pueden trabajar a partir de nuestra especificación OpenAPI?

Sí, pegue el YAML o el JSON en el brief. Convertimos sus descripciones en páginas de referencia legibles y completamos las lagunas que nos indique.

¿Probarán los ejemplos?

No llamamos a su API. Los ejemplos se construyen a partir de sus muestras de solicitudes y respuestas, así que ejecútelos una vez antes de publicar.

¿Escriben documentación de SDK?

Sí, si nos envía las firmas de los métodos y ejemplos de uso. Cada SDK cuenta como parte del volumen del paquete.

Paquetes
Hacer pedido · 39 US$· 3 días