An open API service indexing awesome lists of open source software.

https://github.com/go-andiamo/apui

Make your API browsable!
https://github.com/go-andiamo/apui

api chi chioas go golang

Last synced: 5 months ago
JSON representation

Make your API browsable!

Awesome Lists containing this project

README

          

# apui
[![GoDoc](https://godoc.org/github.com/go-andiamo/apui?status.svg)](https://pkg.go.dev/github.com/go-andiamo/apui)
[![Latest Version](https://img.shields.io/github/v/tag/go-andiamo/apui.svg?sort=semver&style=flat&label=version&color=blue)](https://github.com/go-andiamo/apui/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/go-andiamo/apui)](https://goreportcard.com/report/github.com/go-andiamo/apui)

Make your API browsable!

A golang drop-in package to make your APIs render as browsable, interactive HTML.

![Screenshot](_examples/screenshot.png)

---

## Features

- Single call to write API results as HTML
- Theme support
- Fully configurable
- Uses [Aitch](https://github.com/go-andiamo/aitch) for low GC pressure rendering
- Optionally uses [Chioas](https://github.com/go-andiamo/chioas) for documentation

---

## Working demo

See [Example](https://github.com/go-andiamo/apui/tree/main/_examples/petstore)

---

## Installation

```bash
go get github.com/go-andiamo/apui
```