skip to navigation
skip to content

Not Logged In

endpoints 0.7.4

Get an api up and running quickly

Latest Version: 0.8.5

Quickest api builder in the west! Built for First Opinion.

How does it work?

Endpoints translates requests to python modules without any configuration. It uses the convention:

METHOD /module/class/args?kwargs

To find the modules, you assign a base module (a prefix) that endpoints will use as a reference point to find the correct submodule using the path. This makes it easier to bundle your controllers into something like a controllers module. Some examples of how http requests would be interpretted:

GET / -> prefix.Default.GET()
GET /foo -> prefix.foo.Default.GET()
POST /foo/bar -> prefix.foo.Bar.POST()
GET /foo/bar/che -> prefix.foo.Bar.GET(che)
POST /foo/bar/che?baz=foo -> prefix.foo.Bar.POST(che, baz=foo)

Requests are translated from left bit to right bit of the path (so for path /foo/bar/che/baz, Endpoints would check for the foo module, then the foo.bar module, then the 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 bits, if no class is found, Default will be used.

Example

So, if you set up your site like this:

site/
  controllers/
    __init__.py

and the controllers.__init__.py contained:

from endpoints import Controller

class Default(Controller):
    def GET(self):
        return "called /"

class Foo(Controller):
    def GET(self):
        return "called /foo"

Then, your call requests would be translated like this:

GET / -> controllers.Default.GET()
GET /foo -> controllers.Foo.GET()

Handling path parameters and query vars

You can define your controller methods to accept certain path params and to accept query params:

class Foo(Controller):
  def GET(self, one, two=None, **query_params)

your call requests would be translated like this:

GET /foo/one -> prefix.Foo.GET("one")
GET /foo/one?param1=val1&param2=val2 -> prefix.Foo.GET("one", param1="val1", param2="val2")
GET /foo -> 404, no one path param
GET /foo/one/two -> prefix.Foo.GET("one", "two")

Example application

The example directory has a little server that will demonstrate how endpoints works, you can run it:

$ cd /path/to/endpoints/example
$ python server.py

Then, in another terminal window:

$ curl http://localhost:8000
$ curl http://localhost:8000/foo

Versioning requests

Endpoints has support for Accept header versioning, inspired by this series of blog posts.

If you are using versioning, then the prefix for each controller would be prefix.version. Let's say you've set up your versioned site like this:

site/
  controllers/
    __init__.py
    v1/
      __init__.py
    v2/
      __init__.py

and controllers.v1.__init__.py contained:

from endpoints import Controller

class Default(Controller):
    def GET(self):
        return "called version 1 /"

class Foo(Controller):
    def GET(self):
        return "called version 1 /foo"

And controllers.v2.__init__.py contained:

from endpoints import Controller

class Default(Controller):
    def GET(self):
        return "called version 2 /"

class Foo(Controller):
    def GET(self):
        return "called version 2 /foo"

Then, your call requests would be translated like this:

GET / with Accept: */*;version=v1 -> controllers.v1.Default.GET()
GET /foo with Accept: */*;version=v1 -> controllers.v1.Foo.GET()

GET / with Accept: */*;version=v2 -> controllers.v2.Default.GET()
GET /foo with Accept: */*;version=v2 -> controllers.v2.Foo.GET()

CORS support

Endpoints has a CorsMixin you can add to your controllers to support CORS requests:

from endpoints import Controller, CorsMixin

class Default(Controller, CorsMixin):
    def GET(self):
        return "called / supports cors"

todo, move our auth_basic, and auth_oauth decorators into a decorators sub module? Only problem I see with this is doing the actual authentication, so there needs to be a way for the module to call another method and return if it is valid, not sure how we would want to make that generic or if it is worth trying to make that generic

todo, move the require_params decorator into a decorators sub module - no reason for this one to only be in our code

Install

Use PIP

pip install endpoints

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

pip install git+https://github.com/firstopinion/endpoints#egg=endpoints

To run tests

To run the tests, you'll also need to install the testdata module:

pip install testdata

To run the tests:

python -m unittest endpoints_test

License

MIT

 
File Type Py Version Uploaded on Size
endpoints-0.7.4.tar.gz (md5) Source 2014-01-12 12KB
  • Downloads (All Versions):
  • 591 downloads in the last day
  • 2689 downloads in the last week
  • 4355 downloads in the last month