Saltar al contenido
Índice de Kit UI
Kit UI Componentes

Endpoint API.

Patrón canónico de endpoint api para cis-admin, cis-infra, cis-inbox, usaia y servicios internos.

Verlo por niveles

Primero el componente, después la variación de marca y finalmente su uso dentro de una página.

Nivel 1Componente canónico
GET/api/v1/components200
Accept: application/json
ETag: "498f99c6"

184 componentes · 42 ms

Abrir en OpenAPI
Nivel 2COCHID · variación
GET/api/v1/components503
Accept: application/json
Retry-After: 60

Servicio no disponible · nuevo intento en 60 s

Abrir en OpenAPI
Nivel 3Dentro de una página
Sitio · sección
GET/api/v1/components200
Accept: application/json
ETag: "498f99c6"

184 componentes · 42 ms

Abrir en OpenAPI
Ver y copiar el código de este render
HTML del nivel canónico
<section class="ui-sample ui-service" data-api-endpoint="true"><header><code>GET</code><strong>/api/v1/components</strong><span class="badge badge--ok">200</span></header><pre><code>Accept: application/json
ETag: &quot;498f99c6&quot;</code></pre><p>184 componentes · 42 ms</p><a class="btn btn--quiet" href="#openapi">Abrir en OpenAPI</a></section>

Variaciones por marca y sitio

Cada cambio visible declara su autoridad; lo que permanece canónico no se vuelve a inventar en el producto.

innovacionsantiago.cl

Compañía de Innovación de Santiago

Autoridad: CONSTITUTION.md + LOGOS-CANONICOS.md
GET/api/v1/components200
Accept: application/json
ETag: "498f99c6"

184 componentes · 42 ms

Abrir en OpenAPI

Cambia en esta marca

  • Navegación y contenido propios del servicio
  • Acento reservado para acciones y datos

Permanece canónico

  • Mark CIS y namebrand de tres líneas
  • IBM Plex Sans, foco, espaciado y anatomía
cochid.cl

COCHID

Autoridad: core-style/DECISIONES.md M15 y LOGOS-CANONICOS.md
GET/api/v1/components503
Accept: application/json
Retry-After: 60

Servicio no disponible · nuevo intento en 60 s

Abrir en OpenAPI

Cambia en esta marca

  • Cuadrado azul y namebrand de tres líneas
  • Azul COCHID en selección, capas y series

Permanece canónico

  • Estructura y semántica comunes
  • Fuentes, unidades y alternativa tabular

Comparación histórica recuperable

Compara la propuesta con cortes reales del repositorio. La ausencia de una muestra se declara y nunca se reconstruye de memoria.

Estado actual
Endpoint API no tiene una implementación vigente demostrada; sus ejemplos son material candidato.
Cambio propuesto
Publicar en r19 el contrato de Endpoint API para Patrón canónico de endpoint api para cis-admin, cis-infra, cis-inbox, usaia y servicios internos.
Qué ocurre si respondes No
Endpoint API queda fuera de r19 y sus ejemplos siguen sólo como evidencia pendiente de reformulación.

Preparando comparación histórica…

Antes / r19

La comparación convierte una regla abstracta en una diferencia visible y verificable.

r19 · correctoContrato canónico renderizado
GET/api/v1/components200
Accept: application/json
ETag: "498f99c6"

184 componentes · 42 ms

Abrir en OpenAPI
  • Conecta estado, timestamp y fuente al servicio real.
  • Explica impacto, recuperación y recibo cuando hay una falla.
Antes · problema observadoAnti-ejemplo no interactivo
CONFIRMADOServicio operativoSin healthcheck, timestamp ni recibo
  • No muestres CONFIRMADO o EN LÍNEA sin señal verificable.
  • No expongas secretos, tokens ni trazas con datos personales.

Responsive

La misma anatomía debe conservar lectura, foco y acciones sin cortar contenido ni crear scroll horizontal en la página.

320 pxMóvil y zoom
GET/api/v1/components200
Accept: application/json
ETag: "498f99c6"

184 componentes · 42 ms

Abrir en OpenAPI
1280 pxEscritorio
GET/api/v1/components503
Accept: application/json
Retry-After: 60

Servicio no disponible · nuevo intento en 60 s

Abrir en OpenAPI

Cobertura

DimensiónContrato
Propietario canónicoSistema de diseño CIS e Infraestructura · core/core-style
Consumidorescis-admin, cis-infra, cis-inbox, usaia y servicios internos
DependenciasAPI del servicio, recibos verificables
Estadocandidato

Evidencia de adopción

Patrón propuesto. 0 implementaciones observadas en 0 repositorios.

La observación demuestra uso existente; la aceptación canónica sigue dependiendo de esta ficha y de su propietario.

DatoResultado
ClasificaciónPatrón propuesto
Implementaciones0 implementaciones observadas
RepositoriosNingún repositorio observado
Snapshotkit/componentes/componentes-observados.json

Consumidores observados

El inventario conserva repositorio, archivo fuente y criterio de asociación. Observar una implementación no la convierte automáticamente en canónica.

Estados

Estado requerido
operativo
degradado
fallido
sin datos

Accesibilidad

  • Conserva nombre accesible, orden de lectura y foco visible.
  • Funciona a 320 px, con zoom de 200% y texto largo.
  • El color nunca es la única señal de estado o acción.
  • El contenido esencial permanece disponible sin JavaScript.

Código HTML

Copia el bloque completo; después cambia contenido y destinos, no su anatomía.

Código de referencia
<section class="ui-sample ui-service" data-api-endpoint="true"><header><code>GET</code><strong>/api/v1/components</strong><span class="badge badge--ok">200</span></header><pre><code>Accept: application/json
ETag: &quot;498f99c6&quot;</code></pre><p>184 componentes · 42 ms</p><a class="btn btn--quiet" href="#openapi">Abrir en OpenAPI</a></section>

Código TAILWIND

Copia el bloque completo; después cambia contenido y destinos, no su anatomía.

Código de referencia
<section class="ui-sample ui-service border border-slate-300 bg-white p-4 text-slate-950 grid gap-3" data-api-endpoint="true"><header class="flex flex-wrap items-center justify-between gap-3"><code>GET</code><strong>/api/v1/components</strong><span class="badge badge--ok">200</span></header><pre class="overflow-x-auto border border-slate-300 bg-slate-50 p-3"><code>Accept: application/json
ETag: &quot;498f99c6&quot;</code></pre><p>184 componentes · 42 ms</p><a class="btn btn--quiet underline underline-offset-4" href="#openapi">Abrir en OpenAPI</a></section>

Código REACT

Copia el bloque completo; después cambia contenido y destinos, no su anatomía.

Código de referencia
export interface ApiEndpointProps {
  /** Método HTTP del endpoint. */
  method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
  /** Ruta del endpoint, sin dominio. */
  path?: string;
  /** Código HTTP de la última respuesta; se muestra como etiqueta y vacío la oculta. */
  httpStatus?: number | string;
  /** Tono de la etiqueta del código; por defecto se deduce del código (2xx: `ok`; 3xx: `warn`; 4xx y 5xx: `err`; otro: `neutral`). */
  statusTone?: "ok" | "warn" | "err" | "neutral";
  /** Ejemplo en texto plano (encabezados, cuerpo o comando); acepta varias líneas separadas por `\n`. Vacío oculta el bloque de código. */
  example?: string;
  /** Resultado de la última llamada: volumen, latencia o instrucción de reintento; vacío lo oculta. */
  detail?: string;
  /** URL de la documentación del endpoint. */
  href?: string;
  /** Texto del enlace a la documentación; vacío lo oculta. */
  linkLabel?: string;
  className?: string;
}

function claseEstado(httpStatus: number | string, tone?: "ok" | "warn" | "err" | "neutral") {
  const codigo = Number(httpStatus);
  const deducido = codigo >= 200 && codigo < 300 ? "ok" : codigo >= 300 && codigo < 400 ? "warn" : codigo >= 400 && codigo < 600 ? "err" : "neutral";
  const tono = tone ?? deducido;
  return tono === "neutral" ? "badge" : `badge badge--${tono}`;
}

/**
 * Ficha de un endpoint de API con método, ruta, código de la última respuesta, un ejemplo y enlace a su documentación; se usa en paneles de integración y catálogos de API.
 *
 * El código de la última respuesta va en texto dentro de una etiqueta con tono (`badge`), no sólo en color; el enlace a la documentación es una acción terciaria (`btn--quiet`).
 *
 * @example <ApiEndpoint method="GET" path="/api/v1/components" httpStatus={200} example={"Accept: application/json\nETag: \"498f99c6\""} detail="184 componentes · 42 ms" href="/openapi#components" />
 * @example <ApiEndpoint httpStatus={503} example={"Accept: application/json\nRetry-After: 60"} detail="Servicio no disponible · nuevo intento en 60 s" />
 */
export function ApiEndpoint({
  method = "GET",
  path = "/api/v1/components",
  httpStatus = 200,
  statusTone,
  example = "Accept: application/json\nETag: \"498f99c6\"",
  detail = "184 componentes · 42 ms",
  href = "#openapi",
  linkLabel = "Abrir en OpenAPI",
  className,
}: ApiEndpointProps) {
  return (
    <section className={["ui-service", className].filter(Boolean).join(" ")} data-api-endpoint>
      <header>
        <code>{method}</code>
        <strong>{path}</strong>
        {httpStatus !== "" ? <span className={claseEstado(httpStatus, statusTone)}>{httpStatus}</span> : null}
      </header>
      {example ? (
        <pre>
          <code>{example}</code>
        </pre>
      ) : null}
      {detail ? <p>{detail}</p> : null}
      {linkLabel ? <a className="btn btn--quiet" href={href}>{linkLabel}</a> : null}
    </section>
  );
}