Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 937 Bytes

README.md

File metadata and controls

31 lines (19 loc) · 937 Bytes
Raw

Go Hello OpenAPI

A quick "Hello World" but for generating OpenAPI, using the Go web framework Huma.

Introduction

This codebase is the combination of the two following guides:

  1. Huma > Your First API
  2. Bump.sh > Deploying docs from Huma

The goal is to show you how you can export OpenAPI from your Huma application, and deploy the OpenAPI as API Reference Documentation as Bump.sh hosted docs.

Usage

Clone the repository down to give it a try.

# Start the server
$ go run .

# Export the OpenAPI
$ go run . openapi > openapi.yaml

Preview how the API reference docs look on Bump.sh.

License

The contents of this repository are licensed under CC BY-NC-SA 4.0.