index.md

validataclass Documentation

This is the index of the documentation.

Chapters

1. Introduction

   • What's a Validator?
   • First examples

2. Error Handling

   • What are validation errors?
   • How to handle validation errors
   • Example for a simple REST API

3. Basic Validators

   • Overview of built-in validator classes
   • Examples for most validators

4. Lists and Dictionaries

   • Lists
   • Dictionaries
   • Nested validation errors

5. Validation with Dataclasses

   • What are dataclasses and how to use them for validation?
   • The DataclassValidator
   • The @validataclass decorator and validataclass_field()
   • Defining field defaults
   • Dataclass post-validation
   • Example with nested dataclasses

6. Building new validators

   • (To be written...)