https://github.com/cowwoc/lumina

A JSON-based media type for self-documenting REST APIs
https://github.com/cowwoc/lumina

hateaos lumina readability rest-api self-documenting

Last synced: 12 days ago
JSON representation

A JSON-based media type for self-documenting REST APIs

• Host: GitHub
• URL: https://github.com/cowwoc/lumina
• Owner: cowwoc
• License: apache-2.0
• Created: 2024-01-04T16:02:53.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-05T16:21:19.000Z (over 2 years ago)
• Last Synced: 2025-10-30T20:45:43.383Z (8 months ago)
• Topics: hateaos, lumina, readability, rest-api, self-documenting
• Language: TypeScript
• Homepage:
• Size: 85.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![build-status](../../workflows/Build/badge.svg)](../../actions?query=workflow%3ABuild)

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

# The Lumina Hypermedia Type

Lumina is a JSON-based media type for interacting with web resources through hypermedia controls,

such as links, forms and queries.

✔️ Easy to use  

✔️ Fast  

✔️ Production-ready

# Specifications

* [Media Type](docs/media-type.MD)

* [Sorting, Filtering and Pagination](docs/filtering.MD)

# Getting Started

* [Java SDK](java/README.md)

* [Typescript SDK](typescript/README.md)

## Licenses

* Code licensed under the [Apache License, Version 2.0](LICENSE)