Skip to main content

API Star tools to create CRUD resources.

Project description

build status coverage version

Author:José Antonio Perdiguero López

API Star tools to create CRUD resources.


The resources are classes with a default implementation for methods:

  • create: Create a new element for this resource.
  • retrieve: Retrieve an element of this resource.
  • update: Update (partially or fully) an element of this resource.
  • delete: Delete an element of this resource.
  • list: List resource collection.
  • drop: Drop resource collection.

The routes for these methods are:

Method Verb URL
create POST /
retrieve GET /{element_id}/
update PUT /{element_id}/
delete DELETE /{element_id}/
list GET /
drop DELETE /

Quick start

Install API star CRUD:

pip install apistar-crud

Create a model for your resource:

# Example using SQL Alchemy

class PuppyModel(Base):
    __tablename__ = "Puppy"

    id = Column(Integer, primary_key=True)
    name = Column(String)

Create an input type and output_type for your resource:

class PuppyInputType(types.Type):
    name = validators.String()

class PuppyOutputType(types.Type):
    id = validators.Integer()
    name = validators.String()

Now create your resource:

from apistar_crud.sqlalchemy import Resource

class PuppyResource(metaclass=Resource):
    model = PuppyModel
    input_type = PuppyInputType
    output_type = PuppyOutputType
    methods = ('create', 'retrieve', 'update', 'delete', 'list', 'drop')

The resource generates his own routes, so you can add it to your main routes list:

from apistar import Include

routes = [
    Include('/puppy/', PuppyResource.routes, namespace='puppy'),

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 apistar-crud, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size apistar_crud-0.2.0-py3-none-any.whl (19.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size apistar-crud-0.2.0.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page