Skip to content

chris104957/crudcast

Repository files navigation

Crudcast

Coverage Status Build Status Documentation Status

Crudcast lets you build a fully functioning and OpenAPI-compliant CRUD API with basic auth/user management with a few lines of YAML code.

Installation

Crudcast requires mongodb - install and start as follows:

brew install mongodb
brew service start mongodb

Install crudcast

pip install crudcast

Create a config file, config.yml, in the same folder

models:
  person:
    fields:
      first_name:
        required: true
      last_name:
        required: true
      age:
        type: number

Usage

CD into the folder containing your config.yml, and run this command

crudcast

Go to http://localhost:5000/api/docs to see your documented and fully-functional API

Next steps

Crudcast also allows you to protect your routes with authentication, and even create additional API routes by inserting your own Python code

Please go to http://crudcast.rtfd.io/ for the full docs

Roadmap

Crudcast is brand new and only has a small percentage of the intended functionality so far. In future, I am planning to add support for:

  • More authentication methods (OAuth, Token auth, etc)
  • Advanced permissions
  • Custom validation/permissions

If there is any other functionality you'd like to see added, then please raise an issue

About

Create and deploy a RESTful API with a few lines of YAML

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages