index.md

Documentation Index

You can find the documentation online here: https://columbia-it-django-jsonapi-training.readthedocs.io

Or, to locally view it in a browser:

tox -e mkdocs
mkdocs serve  # or open ./site/index.html

Otherwise, you can just view these documentation source files:

• 'Home'
• 'Welcome and Caveat'
• 'Documentation Revision History'
• 'Preparing for the classes'
• 'Motivation: Strategy and Architectural Standards'
• 'Review: git, Python, JSON'
• 'HTTP and REpresentational State Transfer (docs/REST)'
• 'The {json:api} specification'
• 'Building our DJA project'
• 'Authorizing REST operations Using OAuth 2.0'
• 'Using django-oauth-toolkit as the AS'
• 'Using Columbia OAuth 2.0 as the AS'
• 'Modifying our DJA Project'
• 'Another Modification: Add an Instructor Model and additional relationship'
• 'Database Backends'
• 'Split Instructor model to be OneToOne with new Person model'
• 'Adding OIDC 1.0 Claims'
• 'MkDocs Documentation'
• 'Documenting the API with OAS 3'
• 'Backstage developer portal'
• 'Deploying to Production'
• 'Using AWS API Gateway'
• 'A Command Line Client'
• 'Help Wanted'
• 'Code Reference':
  • 'Models'
  • 'Views'
  • 'Serializers'
  • 'Schemas'
  • 'Tests'