HonoHub Logo

HonoHub

Quick Start

Getting started with the hono-openapi

Introduction

hono-openapi is a library that makes it easy to generate OpenAPI specifications for your Honojs app. It uses your validation schemas and middlewares to create comprehensive API documentation. This package is designed to work seamlessly with all the validation libraries which supports Standard Schema.

It uses @standard-community/standard-json (npm) and @standard-community/standard-openapi (npm) under the hood to generate OpenAPI specifications.

Installation

You can install the hono-openapi package using your preferred package manager.

npm install hono-openapi @hono/standard-validator

Few validation libraries require additional dependencies to work with hono-openapi.

VendorPackage
Zod v3zod-openapi@4 (npm)
Valibot@valibot/to-json-schema (npm)