https://github.com/seancassiere/simple-node-hono-api-server

A dead-simple Node REST API Server with documentation
https://github.com/seancassiere/simple-node-hono-api-server

Last synced: 21 days ago
JSON representation

A dead-simple Node REST API Server with documentation

• Host: GitHub
• URL: https://github.com/seancassiere/simple-node-hono-api-server
• Owner: SeanCassiere
• Created: 2024-06-24T13:18:29.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T02:20:30.000Z (about 2 months ago)
• Last Synced: 2024-10-06T11:06:38.202Z (about 1 month ago)
• Language: TypeScript
• Homepage: https://railway.app/template/nBepLC
• Size: 403 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# API Server (with Node and Hono)

A dead-simple Node REST API Server powered by [Hono](https://hono.dev/) with OpenAPI 3 documentation viewable with [Scalar](https://docs.scalar.com/swagger-editor).

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/nBepLC?referralCode=k9d2VP)

## Development

1. Clone the repository.

2. Install dependencies `npm install`.

3. Run the development server using `npm run dev`.

## Endpoints

- `/api/v1/` - The base URL for the API.

- `/docs` - OpenAPI 3 documentation viewable with Scalar.

- `/openapi.v1.yaml` - OpenAPI 3 documentation in YAML format.