apibin

command module
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 4, 2024 License: MIT Imports: 33 Imported by: 0

README

API Bin

HUMA Powered Works With Restish GitHub

Provides a simple, modern, example API for demoing or debugging various features, including:

  • HTTP, HTTPS (TLS), and HTTP/2
  • OpenAPI 3 & JSON Schema
  • Client-driven content negotiation
    • gzip & br content encoding for large responses
    • JSON, YAML, & CBOR formats
  • Conditional requests via ETag or LastModified
  • Echo back request info to help debugging
  • Cached responses to test proxy & client-side caching
  • Example structured data
    • Shows off object, array, string, date, binary, integer, number, boolean, etc.
  • A sample CRUD API for books & reviews with simulated server-side updates
  • Image responses JPEG, WEBP, GIF, PNG & HEIC
  • RFC7807 structured errors

This project is open source: https://github.com/danielgtaylor/apibin

You can run it localy via Docker:

# Start the server
$ docker run -p 8888:8888 ghcr.io/danielgtaylor/apibin:latest

# Make a request
$ restish :8888/types

Documentation

Overview

This file is copied from Huma v1 middleware, slightly modified to use v2 for content negotiation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL