Bastien Sevajol 19a0d968c7 python 3.4 campat 3 years ago
example python 3.4 campat 3 years ago
hapic python 3.4 campat 3 years ago
tests python 3.4 campat 3 years ago
.coveragerc Create .coveragerc 3 years ago
.coveralls.yml Update .coveralls.yml 3 years ago
.editorconfig Add .editorconfig file 3 years ago
.gitignore python 3.4 campat 3 years ago
.travis.yml python 3.4 campat 3 years ago
README.md fixes wrong whitespaces 3 years ago
setup.py v0.22 3 years ago

README.md

Build Status Coverage Status

Hapic in a nutshell

Hapic is a framework-agnostic library for implementation of professionnal REST APIs.

Why you should use Hapic :

  • Hapic adapt naturally to your existing libraries
  • Hapic map exceptions to HTTP errors without effort
  • Hapic really auto-documents your APIs according to marshmallow, apispec and web framework routing. You do not "write your doc in docstrings": the documentation is really auto-generated
  • Hapic can be used out-of-the-box with Bottle, Flask or Pyramid

Hapic works with JSON, but it can be used for XML or virtually any data structure format.

Auto-generated documentation can be visualised with swagger.

Philosophy

Hapic as been developed by algoo in the context of a large client project. The lack of a tool allowing real auto-documentation of Rest API has decided us to develop Hapic.

Target projects of Hapic are not "quick and dirty" but professionnally architectured projects.

The separation of concerns between REST APIs layer and Business Stuff layer is in the DNA of Hapic. Hapic is just the HTTP Layer over your business code.

Licence

Hapic is licenced under the MIT licence. You can use it in your projects, closed or open sourced.

Status, contributions

Hapic source code is ready for production. Some refactoring are identified and required for maintainability, but public APIs are stable so you can rely on Hapic for your developments.

Hapic is under active development, based on Algoo projects. We will answer your questions and accept merge requests if you find bugs or want to include functionnalities.

TODO references

TODO can make reference to #X, this is github issues references.

Installation

virtualenv -p /usr/bin/python3 venv
source venv/bin/activate
python setup.py develop

Give it a try

A complete user API

In the example/usermanagement directory you can find a complete example of an API allowing to manage users.

Features are:

  • get list of all users
  • get detail of a given user
  • create a user
  • delete a user

In order to test it :

Install the required dependencies:

pip install bottle flask pyramid`

Run the instance you wan to test (one of the three following lines):

python example/usermanagement/serve_bottle.py
python example/usermanagement/serve_flask.py
python example/usermanagement/serve_pyramid.py

Features shown :

  • auto-generation of the documentation
  • managing parameters in the uri path
  • managing input schemas
  • managing output schema
  • management of error cases (404, 500, etc)
  • nice exception handling
  • automatic dict/object serialization