schema-generator

command
v0.0.0-...-ee43cbb Latest Latest
Warning

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

Go to latest
Published: Sep 5, 2017 License: Apache-2.0 Imports: 11 Imported by: 0

README

OpenAPI 3.0 Schema Generator

This directory contains a support tool that reads (scrapes) the Markdown text specification for OpenAPI 3.0 and builds a corresponding JSON schema.

It also contains "3.0.md", a local copy of the OpenAPI specification with modifications that fix minor inconsistencies and make it easier to read. We hope to have these changes merged into the official document.

Disclaimer

This does not generate the official OpenAPI 3.0 JSON Schema, which at the time of this commit, does not exist.

Documentation

Overview

schema-generator is a support tool that generates the OpenAPI v3 JSON schema. Yes, it's gross, but the OpenAPI 3.0 spec, which defines REST APIs with a rigorous JSON schema, is itself defined with a Markdown file. Ironic?

Jump to

Keyboard shortcuts

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