prmd
A Ruby CLI tool for scaffolding, verifying, and generating documentation from JSON Schema for HTTP APIs.
What is prmd?
Prmd is a Ruby-based command-line tool for working with JSON Schema to describe HTTP APIs. It provides utilities to scaffold resource schemas, combine them with metadata, verify their correctness, and generate comprehensive API documentation. It solves the problem of maintaining consistent and up-to-date API documentation by automating the process from schema definitions.
API developers and teams designing HTTP APIs who want to use JSON Schema as a specification format and need tooling for scaffolding, validation, and documentation generation.
Developers choose Prmd for its focused workflow that integrates seamlessly with JSON Schema, its support for both JSON and YAML, and its ability to automate documentation generation, reducing manual upkeep and ensuring documentation stays synchronized with the API design.
Overview
JSON Schema tools and doc generation for HTTP APIs
Use Cases
Best For
- Generating API documentation from JSON Schema definitions
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
