https://github.com/vikash1596kumarkharwar/openapispec2

auto-api-docs-generator
https://github.com/vikash1596kumarkharwar/openapispec2

Last synced: 20 days ago
JSON representation

auto-api-docs-generator

• Host: GitHub
• URL: https://github.com/vikash1596kumarkharwar/openapispec2
• Owner: VIKASH1596KUMARKHARWAR
• Created: 2024-12-16T09:36:27.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-12-16T09:54:14.000Z (about 1 month ago)
• Last Synced: 2024-12-16T10:31:49.455Z (about 1 month ago)
• Language: JavaScript
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Hono + Zod + OpenAPI

This repository provides an automatic API documentation generation solution using **Hono**, **Zod**, and **OpenAPI**. It allows you to easily define APIs and generate corresponding OpenAPI specifications with the help of Hono for routing, Zod for validation, and OpenAPI for documentation.

## Technologies Used

- **Hono**: A fast and lightweight web framework for building APIs.

- **Zod**: A TypeScript-first schema declaration and validation library, used for request/response validation.

- **OpenAPI**: A specification for defining APIs and auto-generating API documentation.

## Features

- **Automatic API Documentation**: Seamlessly integrates Hono, Zod, and OpenAPI to auto-generate API documentation.

- **Schema Validation**: Uses Zod for defining and validating input and output schemas for API requests and responses.

- **Fast and Lightweight**: Powered by Hono, ensuring minimal overhead and optimal performance.

## Setup

### Prerequisites

- Node.js (version 16 or higher)

- npm or yarn

### Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/VIKASH1596KUMARKHARWAR/hono-zod-openapi.git

```

npm install

npm run dev

```

```

http://localhost:8787/users/123123

http://localhost:8787/doc

http://localhost:8787/ui

```