lookupproxy

This is the documentation for the lookupproxy project which provides a proxy for the University of Cambridge Lookup API. The body of the reference material can be found in the section on the lookupapi application.

If you don’t know where to start then the getting started guide is a good bet.

Contents

• Getting started
  • Fork the upstream repository
  • Set up cloud integrations
  • Clone the repository locally
  • Install any requirements
  • Set up local configuration
  • Start the development server
  • Next steps
• Developer’s guide
  • Local development
  • Docker images
  • Cloud infrastructure
• Configuration
  • Specifying the database
  • Default settings
• The lookupproxy project
  • Extensions to drf-yasg
  • Settings
  • Custom test suite runner
• The lookupapi Application
  • Installation
  • Default settings
  • Views and serializers
  • Authentication and permissions
  • Extensions to drf-yasg
  • Accessing the Lookup API
  • Default URL routing
  • Application configuration