OKF Tutorial
Use the main tutorial for the full workflow.
Open pageHow-to guide
How to create OKF for API docs
Create OKF for API docs by keeping OpenAPI as the contract and adding OKF files for endpoint context.
Short answer
Create OKF for API docs by keeping OpenAPI as the contract and adding OKF files for endpoint context.
Prerequisites
- A Markdown file or source page to convert.
- A clear concept boundary.
- A canonical source URL or stable resource identifier.
- Access to the OKF Validator for structure checks.
Step-by-step tutorial
- Start from the API reference.
- Create one OKF file per endpoint or API area.
- Link the OpenAPI resource.
- Add examples and errors.
- Validate frontmatter.
Copyable example
---
type: API Endpoint
title: List invoices endpoint
description: Explains endpoint purpose, filters, limits, and related billing rules.
resource: https://openknowledgeformat.online/guides/how-to-create-okf-for-api-docs/
tags: [okf, guide, example]
timestamp: 2026-06-21T00:00:00Z
---
# Purpose
Explain the stable facts, boundaries, owner notes, and related links for this concept.
# Links
- Validator: https://openknowledgeformat.online/okf-validator/
- Examples: https://openknowledgeformat.online/okf-examples/Common mistakes
- Trying to cover too many concepts in one file.
- Leaving metadata blank or vague.
- Treating validation as proof that every claim is correct.
- Publishing private or unreviewed information.
Validation method
- Paste the file into the OKF Validator.
- Fix errors before warnings.
- Check links and source claims manually.
- Add the file to the bundle index.
Related page links
- OKF Tutorial for the full beginner workflow.
- OKF Examples for bundle structures.
- OKF Templates for copyable starting points.
FAQ
Common questions
Does this require a database?
No. A folder of Markdown files is enough for the first version.
Can I automate this?
You can generate drafts, but owners should review source accuracy and boundaries.