Plantilla OKF

Plantilla OKF de documentación API

Plantilla OKF inicial para documentar APIs REST y RPC.

Markdown listo para copiar

Usuarios que necesitan una plantilla OKF para documentación de API.

---
type: api_reference
id: api-docs
title: "API Docs OKF Template"
description: "Starter OKF template for documenting REST and RPC APIs."
tags: [template, api, developer-docs]
---

# API Name

Short description of what the API does.

## Authentication

Describe required credentials, scopes, and rate limits.

## Core endpoints

### METHOD /path

Describe the endpoint, required parameters, and response shape.

## Error handling

List common error codes and recovery actions.

Herramientas y guías OKF relacionadas

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

FAQ

¿Esta plantilla es OKF válida?

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.