OKF 例

API endpoint の OKF 例

エージェント可読 API ドキュメント向けの単一 endpoint リファレンスページ。

コピー可能な Markdown

OKF 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.

関連する OKF ツールとガイド

OKF バリデーター Web から OKF 生成 OpenAPI から OKF 変換 OKF vs JSON-LD OKF vs OpenAPI

FAQ

この例は有効な OKF ですか？

はい。生成される Markdown には必須の type frontmatter と補助メタデータが含まれます。

そのまま本番で使えますか？

出発点として使い、公開前にドメイン固有の事実へ置き換えてください。

次に何をすべきですか？

ファイルを検証し、所有者/出典メタデータを追加し、bundle index やドキュメントハブからリンクします。