API Boilerplate

api.boilerplate is a tornado-based boilerplate for API projects

Note

Detailed specifications for endpoints could be found in the Swagger schema.

Quick Start

• EXAMPLES
  • /document endpoint

Table of Contents

• How to start
• Settings
  • Configiration parameters
  • Environment variables
  • Logging
• How to Deploy
  • Local environment
  • Testing environment
  • Staging environment
  • Production environment
• Versioning
  • Request
  • Response
• Dependencies
• Testing
  • External API Testing
  • Build-In Tests
• API Documentation
  • api package
  • bootstrap module
  • fabfile package
  • setup module

Index

• Index
• Module Index
• Search Page