Skip to content

pdonorio/restapi-template

 
 

Repository files navigation

REST API development base

This is an attempt to have a multi-container micro-services environment to easily develop REST API in Python.

--

Pre-requisites

Before starting please make sure that you have installed on your system:

## Quick start

If you need to jump in as soon as possible:

# Clone this repository
git clone https://github.com/pdonorio/restapi-template.git
# Init services
./do init
# Then run the final services
./do DEVELOPMENT
### Develop from here!

# You may also create another shell to mimic the API client
./do client_shell
/ # http GET http://apiserver/api/status

## Training Note: this is a very good place to get started with the python neomodel library

With the following commands you can setup your machine to start training on handling data from/to:

  • iRODS (B2SAFE)
  • and GraphDB (neo4j)
git clone https://github.com/pdonorio/restapi-template.git
./do init
./do training

At this point you may start to code and interact with iRODS and neo4j.

The files that you may edit are:

  • training/custom.py: just edit the class CustomClass, the method run is enough. You can find basic examples commented (irods commands, neo4j cypher query, neo4j models).
  • training/models.py: models to be used inside the GraphDB. Based on neomodel.

About

Example usage for RESTful HTTP API framework

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 56.2%
  • Shell 41.7%
  • Nginx 2.1%