Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A RESTful web API for Mezzanine CMS.

Project description

Created by George Cushen

Overview

Mezzanine API is a RESTful web API built using the Django framework which extends the Mezzanine content management platform. It gives you freedom to interact with the Mezzanine backend via innovative frontends such as an Angular Javascript based one or mobile app.

Features

  • Endpoints for posts, pages, users, and categories
  • Web browserable API
  • Well documented endpoints
  • Leverages Django Rest Framework
  • Highly efficient
  • Easy to use
  • Clean code

Roadmap

  • More endpoints
  • Refinement
  • Token based authentication
  • Writeable API access
  • Test Suite

Installation

  1. In your terminal, run pip:

    $ pip install mezzanine-api
    
  2. Add the following three apps to INSTALLED_APPS in your Mezzanine settings.py:

    INSTALLED_APPS = (
        ...
        'api',
        'rest_framework',
        'rest_framework_swagger',
    )
    
  3. Also, put the following code in your Mezzanine settings.py:

    #####################
    # REST API SETTINGS #
    #####################
    try:
        from api.settings import *
    except ImportError as e:
        pass
    
  4. Put the following code in your Mezzanine urls.py:

    # REST API URLs
    urlpatterns += patterns("",
        ("^api/", include("api.urls")),
    )
    
  5. Start the server:

    $ python manage.py runserver
    
  6. Visit http://127.0.0.1:8000/api/ to view the documentation and query the API.

Contributing

Mezzanine API is an open source project managed using the Git version control system. The repository is hosted on
GitHub , so contributing is as easy as forking the project and committing back your enhancements.

Support

For support, feel free to ask on the mezzanine-users mailing list.

Otherwise, if you have found a bug, please use the GitHub issue tracker and include the steps necessary to reproduce it.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mezzanine-api, version 0.1.0a1
Filename, size File type Python version Upload date Hashes
Filename, size mezzanine_api-0.1.0a1-py2.py3-none-any.whl (7.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size mezzanine-api-0.1.0a1.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page