endpoints 9.1.1

Get an api up and running quickly

Endpoints

Endpoints is a lightweight REST api framework written in python that supports both WSGI and ASGI. Endpoints has been used in multiple production systems that handle millions of requests daily.

Getting Started

Installation

First, install endpoints with the following command.

$ pip install endpoints

If you want the latest and greatest you can also install from source:

$ pip install -U "git+https://github.com/jaymon/endpoints#egg=endpoints"

Create a Controller Module

Create a controller file with the following command:

$ touch controllers.py

Add the following code to the controllers.py file:

from endpoints import Controller

class Default(Controller):
  """The special class `Default` handles / requests"""
  async def GET(self):
    return "Default handler"

  async def POST(self, **kwargs):
    return 'hello {}'.format(kwargs['name'])

class Foo(Controller):
  """This class handles `/foo` requests"""
  async def GET(self):
    return "Foo handler"

Start a WSGI Server

Now that you have your controllers.py, let's use the built-in WSGI server to serve them, we'll set our controllers.py file as the controller prefix so Endpoints will know where to find the Controller classes we just defined:

$ endpoints --prefix=controllers --host=localhost:8000

Start an ASGI Server

Install Daphne:

$ pip install -U daphne

And start it:

$ ENDPOINTS_PREFIX=controllers daphne -b localhost -p 8000 -v 3 endpoints.interface.asgi:Application.factory

Test it out

Using curl:

$ curl http://localhost:8000
"Default handler"
$ curl http://localhost:8000/foo
"Foo handler"
$ curl http://localhost:8000/ -d "name=Awesome you"
"hello Awesome you"

That's it!

In the first request (/), the controllers module was accessed, then the Default class, and then the GET method.

In the second request (/foo), the controllers module was accessed, then the Foo class as specified in the path of the url, and then the GET method.

Finally, in the last request, the controllers module was accessed, then the Default class, and finally the POST method with the passed in argument.

How does it work?

Endpoints translates requests to python modules without any configuration.

It uses the following convention.

<HTTP-METHOD> /<MODULE-PATH>/<CLASS-PATH>/<POSITIONAL-ARGUMENTS>?<KEYWORD-ARGUMENTS>

Endpoints will use the prefix module path you set as a reference point (either passed in via the environment variable ENDPOINTS_PREFIX or passed into the Application(controller_prefix=...) instance) to find the correct submodule using the path specified by the request.

Requests are translated from the left bit to the right bit of the path. So for the path /foo/bar/che/baz, endpoints would first check for the <PREFIX>.foo module, then the <PREFIX>.foo.bar module, then the <PREFIX>.foo.bar.che module, etc. until it fails to find a valid module.

Once the module is found, endpoints will then attempt to find the class with the remaining path parts. If no matching class is found then a class named Default will be used if it exists.

Once if finds the class, it will use the <HTTP-METHOD> (eg, GET) to decide what method on the found class to call.

This makes it easy to bundle your controllers into a controllers package/module.

Learn more about Endpoints

The docs contain more information about how Endpoints works and what can be done with it.