audoma - API Automatic Documentation Maker
latest

Contents:

  • Installation
  • Usage
  • Contributing to audoma
  • License
  • Changelog
  • Overview
audoma - API Automatic Documentation Maker
  • »
  • Welcome to audoma - API Automatic Documentation Maker’s documentation!
  • Edit on GitHub

Welcome to audoma - API Automatic Documentation Maker’s documentation!

Audoma is a Python library that was designed to make Django Rest Framework documentation easier and more automatic. It’s build on the top of drf-spectacular and extends some of its functionalities.

Contents:

  • Installation
    • Python version
    • Dependencies
    • Install Audoma
    • Audoma initial configuration
  • Usage
    • Viewset defined serializers
    • Viewset defined headers
    • Permissions
    • Custom choices
    • Filters
    • Validators
    • Decorators
    • Examples
    • Extra Fields
    • Serializer Field links
    • Schema Extensions
  • Contributing to audoma
    • Issues
    • Pull requests
    • Running unit tests
    • Example application
  • License
  • Changelog
    • 0.6.0
  • Overview
    • audoma.choices
    • audoma.decorators
    • audoma.examples
    • audoma.hooks
    • audoma.mixins
    • audoma.openapi
    • audoma.django.db.fields
    • audoma.django.forms.fields
    • audoma.drf.decorators
    • audoma.drf.fields
    • audoma.drf.filters
    • audoma.drf.generics
    • audoma.drf.mixins
    • audoma.drf.serializers
    • audoma.drf.validators
    • audoma.drf.viewsets

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2022, Iteo. Revision 4db32d94.

Built with Sphinx using a theme provided by Read the Docs.