https://github.com/jgontrum/connexion-cookiecutter

Template for building micro service APIs with Connexion, deployed via Docker and running with uWSGI & NGINX.
https://github.com/jgontrum/connexion-cookiecutter

connexion cookiecutter docker logstash microservice restful-api template

Last synced: 4 months ago
JSON representation

Template for building micro service APIs with Connexion, deployed via Docker and running with uWSGI & NGINX.

• Host: GitHub
• URL: https://github.com/jgontrum/connexion-cookiecutter
• Owner: jgontrum
• License: mit
• Created: 2016-12-09T22:24:16.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-06-01T21:46:32.000Z (over 3 years ago)
• Last Synced: 2023-08-17T08:08:38.638Z (over 1 year ago)
• Topics: connexion, cookiecutter, docker, logstash, microservice, restful-api, template
• Language: Python
• Homepage:
• Size: 30.3 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Connexion Cookiecutter Template

This Cookiecutter template helps you setting up a RESTful API in minutes. Just answer some questions about you and your projects and a ready-to-go python project will be created.

## Requirements

- Python

- Cookiecutter. Just run ```pip install cookiecutter``` :)

## Usage

```bash

cookiecutter https://github.com/jgontrum/connexion-cookiecutter.git

cd /

make

env/bin/start_debug

```

## Features

- Ready-to-go **Python 3.6** project

- Routing defined in **Swagger** definition

- Strict **model validation** by default

- **Dockerfile**

- Deployed as a uwsgi app behind nginx

- Direct support for static files (-> nginx)

- **Logstash** configuration (optional)

- Examples for **unit and integration tests**

- **Coverage reports** for tests

- Configuration for SonarQube

## Scripts

```make``` Build project

```make clean``` Clean folder

```make test``` Run tests

```make build-and-push``` Build Docker image and push to repository