type-spec

Type Specification for JSON & Dynamic Type Checking & Document Generation

Usage no npm install needed!

<script type="module">
  import typeSpec from 'https://cdn.skypack.dev/type-spec';
</script>

README

TypeSpec

Features

  • API Specification via Coding (instead of document writing)
  • Automatic data sample generation
  • Automatic document generation
  • Better type specification for functions
  • Runtime format checking

Documents

Working

  • Automatic data mocking
  • Automatic smoke testing
  • Better documents about how to use this tool
  • Make this an npm script
  • Full Covered Unit Test
  • Generate more kinds of documents (text, markdown, static html etc.)

Todo

  • Better Error Message
  • Automatic input forms generation
  • Editor for typed data
  • Recursive type definition