All Projects → noirbizarre → Flask Restplus

noirbizarre / Flask Restplus

Licence: other
Fully featured framework for fast, easy and documented API development with Flask

Programming Languages

139335 projects - #7 most used programming language

Projects that are alternatives of or similar to Flask Restplus

Flask Restx
Fork of Flask-RESTPlus: Fully featured framework for fast, easy and documented API development with Flask
Stars: ✭ 1,050 (-59.38%)
Mutual labels:  api, rest, swagger, restful, json, flask
Easy OpenAPI specs and Swagger UI for your Flask API
Stars: ✭ 2,825 (+9.28%)
Mutual labels:  api, swagger, restful, flask
Http Fake Backend
Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
Stars: ✭ 253 (-90.21%)
Mutual labels:  api, rest, restful, json
🔥 Fire up your API with this flamethrower
Stars: ✭ 161 (-93.77%)
Mutual labels:  api, rest, swagger, restful
Koa Rest Api Boilerplate
💯 Boilerplate for Node.js Koa RESTful API application with Docker, Swagger, Jest, CodeCov and CircleCI
Stars: ✭ 420 (-83.75%)
Mutual labels:  api, rest, swagger, restful
FastAPI framework, high performance, easy to learn, fast to code, ready for production
Stars: ✭ 39,588 (+1431.45%)
Mutual labels:  api, rest, swagger, json
Generator Http Fake Backend
Yeoman generator for building a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
Stars: ✭ 49 (-98.1%)
Mutual labels:  api, rest, restful, json
Api Client Generator
Angular REST API client generator from Swagger YAML or JSON file with camel case settigs
Stars: ✭ 92 (-96.44%)
Mutual labels:  api, rest, swagger, json
Node Express Mongoose Passport Jwt Rest Api Auth
Node, express, mongoose, passport and JWT REST API authentication example
Stars: ✭ 146 (-94.35%)
Mutual labels:  api, rest, restful
Node Express Postgresql Sequelize
Node.js, Express.js, Sequelize.js and PostgreSQL RESTful API
Stars: ✭ 148 (-94.27%)
Mutual labels:  api, rest, restful
API development made easy: a smart Python 3 API framework
Stars: ✭ 152 (-94.12%)
Mutual labels:  api, rest, flask
Grafana datasource to load JSON data over your arbitrary HTTP backend
Stars: ✭ 146 (-94.35%)
Mutual labels:  api, rest, json
💨 Simple yet powerful file-based mock server with recording abilities
Stars: ✭ 142 (-94.51%)
Mutual labels:  api, rest, json
The server component of API Platform: hypermedia and GraphQL APIs in minutes
Stars: ✭ 2,004 (-22.48%)
Mutual labels:  api, rest, swagger
Stars: ✭ 141 (-94.55%)
Mutual labels:  rest, swagger, restful
Api Diff
A command line tool for diffing json rest APIs
Stars: ✭ 164 (-93.66%)
Mutual labels:  api, rest, json
angular module to get and display data by adding html-attributes
Stars: ✭ 135 (-94.78%)
Mutual labels:  api, rest, json
Robot Framework library for RESTful JSON APIs
Stars: ✭ 157 (-93.93%)
Mutual labels:  api, rest, json
The Rest Architectural Style
An article on the REST architecture style.
Stars: ✭ 168 (-93.5%)
Mutual labels:  api, rest, restful
GraphQL to REST converter: automatically generate a RESTful API from your existing GraphQL API
Stars: ✭ 181 (-93%)
Mutual labels:  api, rest, restful

Flask RestPlus

Build status Code coverage Documentation status License Supported Python versions Join the chat at


This project has been forked to Flask-RESTX and will be maintained by by the python-restx organization. Flask-RESTPlus should be considered unmaintained.

The community has decided to fork the project due to lack of response from the original author @noirbizarre. We have been discussing this eventuality for almost a year.

Things evolved a bit since that discussion and a few of us have been granted maintainers access to the github project, but only the original author has access rights on the PyPi project. As such, we been unable to make any actual releases. To prevent this project from dying out, we have forked it to continue development and to support our users.

Flask-RESTPlus is an extension for Flask that adds support for quickly building REST APIs. Flask-RESTPlus encourages best practices with minimal setup. If you are familiar with Flask, Flask-RESTPlus should be easy to pick up. It provides a coherent collection of decorators and tools to describe your API and expose its documentation properly using Swagger.


Flask-RestPlus requires Python 2.7 or 3.4+.


You can install Flask-Restplus with pip:

$ pip install flask-restplus

or with easy_install:

$ easy_install flask-restplus

Quick start

With Flask-Restplus, you only import the api instance to route and document your endpoints.

from flask import Flask
from flask_restplus import Api, Resource, fields

app = Flask(__name__)
api = Api(app, version='1.0', title='TodoMVC API',
    description='A simple TodoMVC API',

ns = api.namespace('todos', description='TODO operations')

todo = api.model('Todo', {
    'id': fields.Integer(readOnly=True, description='The task unique identifier'),
    'task': fields.String(required=True, description='The task details')

class TodoDAO(object):
    def __init__(self):
        self.counter = 0
        self.todos = []

    def get(self, id):
        for todo in self.todos:
            if todo['id'] == id:
                return todo
        api.abort(404, "Todo {} doesn't exist".format(id))

    def create(self, data):
        todo = data
        todo['id'] = self.counter = self.counter + 1
        return todo

    def update(self, id, data):
        todo = self.get(id)
        return todo

    def delete(self, id):
        todo = self.get(id)

DAO = TodoDAO()
DAO.create({'task': 'Build an API'})
DAO.create({'task': '?????'})
DAO.create({'task': 'profit!'})

class TodoList(Resource):
    '''Shows a list of all todos, and lets you POST to add new tasks'''
    def get(self):
        '''List all tasks'''
        return DAO.todos

    @ns.marshal_with(todo, code=201)
    def post(self):
        '''Create a new task'''
        return DAO.create(api.payload), 201

@ns.response(404, 'Todo not found')
@ns.param('id', 'The task identifier')
class Todo(Resource):
    '''Show a single todo item and lets you delete them'''
    def get(self, id):
        '''Fetch a given resource'''
        return DAO.get(id)

    @ns.response(204, 'Todo deleted')
    def delete(self, id):
        '''Delete a task given its identifier'''
        return '', 204

    def put(self, id):
        '''Update a task given its identifier'''
        return DAO.update(id, api.payload)

if __name__ == '__main__':


Flask-RESTPlus is brought to you by @noirbizarre. Since early 2019 @SteadBytes, @a-luna, @j5awry, @ziirish volunteered to help @noirbizarre keep the project up and running. Of course everyone is welcome to contribute and we will be happy to review your PR's or answer to your issues.


The documentation is hosted on Read the Docs


Want to contribute! That's awesome! Check out CONTRIBUTING.rst!

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].