Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/danielgtaylor/apibin

Example API with modern features
https://github.com/danielgtaylor/apibin

api brotli cbor conditional-request gzip httpbin json json-schema openapi3 testing yaml

Last synced: 11 days ago
JSON representation

Example API with modern features

Host: GitHub
URL: https://github.com/danielgtaylor/apibin
Owner: danielgtaylor
License: mit
Created: 2022-04-23T19:39:15.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-02-04T17:41:53.000Z (9 months ago)
Last Synced: 2024-10-05T22:02:38.577Z (about 1 month ago)
Topics: api, brotli, cbor, conditional-request, gzip, httpbin, json, json-schema, openapi3, testing, yaml
Language: Go
Homepage: https://api.rest.sh/
Size: 1.45 MB
Stars: 5
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # API Bin

[![HUMA Powered](https://img.shields.io/badge/Powered%20By-Huma-ff5f87)](https://huma.rocks/) [![Works With Restish](https://img.shields.io/badge/Works%20With-Restish-ff5f87)](https://rest.sh/) [![GitHub](https://img.shields.io/github/license/danielgtaylor/apibin)](https://github.com/danielgtaylor/apibin)

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

- HTTP, HTTPS (TLS), and [HTTP/2](https://http2.github.io/)

- [OpenAPI 3](https://www.openapis.org/) & [JSON Schema](https://json-schema.org/)

- 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](https://datatracker.ietf.org/doc/html/rfc7807) structured errors

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

You can run it localy via Docker:

```sh

# Start the server

$ docker run -p 8888:8888 ghcr.io/danielgtaylor/apibin:latest

# Make a request

$ restish :8888/types

```