Ramses
stable
  • Getting started
  • RAML Configuration
  • Defining Schemas
  • Fields
  • Event Handlers
  • Field processors
  • Relationships
  • Changelog
Ramses
  • Docs »
  • Ramses
  • Edit on GitHub

Ramses¶

Ramses is a framework that generates a RESTful API using RAML. It uses Pyramid and Nefertari which provides Elasticsearch / Posgres / MongoDB / Your Data Store™ -powered views. Using Elasticsearch enables Elasticsearch-powered requests which provides near real-time search.

Website:
http://ramses.tech
Source code:
http://github.com/ramses-tech/ramses

Table of Contents¶

  • Getting started
    • Requirements
    • Examples
    • Tutorials
  • RAML Configuration
    • Authentication
    • ACLs
    • Enabling HTTP Methods
  • Defining Schemas
    • JSON Schema
    • Showing Fields
    • Nested Documents
    • Custom “user” Model
  • Fields
    • Types
    • Required Fields
    • Primary Key
    • Constraints
    • Default Value
    • Update Default Value
    • List Fields
    • Other _db_settings
  • Event Handlers
    • Setup
    • Example
    • Other Things You Can Do
  • Field processors
    • Setup
    • Example
  • Relationships
    • Basics
    • Field “type”: “relationship”
    • Field “type”: “foreign_key”
    • One to One relationship
    • Multiple relationships
    • Complete example
  • Changelog
_images/ramses.jpg

Image credit: Wikipedia

Next

© Copyright 2015, Brandicted. Revision 51b2094a.

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