Ejemplo OKF

Ejemplo OKF de endpoint de API

Página de referencia de un endpoint para documentación de API legible por agentes.

Markdown listo para copiar

Desarrolladores que buscan ejemplos OKF de API.

---
type: api_reference
id: api-endpoint
title: "API Endpoint OKF Example"
description: "A single endpoint reference page for agent-readable API documentation."
tags: [api, openapi, reference]
---

# Create Customer Endpoint

Creates a customer record and returns the canonical customer ID.

## Request

POST /v1/customers

Required JSON fields:

- email: customer email address
- name: display name

## Response

Returns 201 with id, email, name, and created_at.

Herramientas y guías OKF relacionadas

Validador OKF Generador web a OKF Conversor OpenAPI a OKF OKF vs JSON-LD OKF vs OpenAPI

FAQ

¿Este ejemplo es OKF válido?

Sí. El Markdown generado incluye el frontmatter type obligatorio y metadatos de apoyo.

¿Puedo usarlo en producción?

Úsalo como punto de partida y luego sustituye los hechos específicos del dominio antes de publicarlo.

¿Qué debo hacer después?

Valida el archivo, añade metadatos de propiedad/origen y enlázalo desde un índice de paquete o centro de documentación.