Lizard-structure: The Lizard api

Tagline of this app: structure of Lizard, defined and documented in a REST interface.

Lizard is a framework for showing water-related information in a web interface. We build most of what’s now Lizard in the Python web framework Django. We’re now separating the various bits and pieces more formally with a REST web API.

A REST API means you can tie in easier into Lizard with your own software instead of buying into Lizard’s whole Python and Django stack.

Lizard-structure provides the documentation on the API. It also provides base view classes for Django to make it very easy to support the API with all the existing Django Lizard apps. The main goal however is documentation.

Here is the table of contents:

• Introducing the four core Lizard concepts
  • Data source
  • Layer tree
  • Layer
  • Feature
• Django base views for implementing your API
  • Data source view
  • TODO: Layer tree view
  • TODO: Layer view
  • TODO: Feature view
• Item definitions: what key/value pairs to expect
  • Layer tree
  • Heading in a menu
  • Layer (workspace acceptable) in a menu
• Helper functions and base classes
  • Helper base view
  • Base class for building item definitions
  • Helper function for generating item definition documentation
• Project documentation
  • Lizard-structure project documentation
  • Changelog of lizard-structure
  • Credits