apinf / openapi-space Goto Github PK

View Code? Open in Web Editor NEW

4.0 4.0 3.0 71 KB

A backend for storing OpenAPI specifications

Home Page: https://openapi.space

License: European Union Public License 1.1

Python 92.75% Shell 5.62% Makefile 1.62%

open-api swagger-spec

openapi-space's Introduction

OpenAPI space

A backend for storing OpenAPI specifications

Setup

Have Python 3.5 or higher installed. Lower python 3.x versions may or may not work.

Automated, dev environment

Run the setup script (./setup.sh)
Run the server (./start.sh)

Automated, Docker

Build the image (docker build . -t openapi-space)
Run docker run -p <port>:80 openapi-space replacing <port> with the port you want the app to be accessible at.
OpenAPI space should now be accessible at http://localhost:<port>

Manual

Install virtualenv
Create a virtualenv (virtualenv -p /path/to/python3 venv)
Enter the virtualenv (source venv/bin/activate)
Install dependencies (pip install -r requirements.txt)
Start the server
- Development mode: python main.py
- uWSGI: uwsgi --ini uwsgi.ini

Development Status

openapi-space's People

Contributors

Stargazers

Watchers

Forkers

mikeralphson mauriciovieira socialskycorporation

openapi-space's Issues

Arrange meeting between principle project stakeholders

In order to make sure this project meets the needs/goals of the main stakeholders, it is important that we meet briefly, and perhaps periodically. Lets set up an initial meeting, where we can agree on our work and goals.

cc: @MikeRalphson @ccsr @tulir @xylix @bajiat

Please add a comment below, or thumbs up to this issue, to indicate interest.

Enable CLA for this project

In order to hold the Copyright to all contributions to this codebase, APInf needs developers to sign a Contributor License Agreement (CLA).

Goal

Require contributors to sign a CLA before accepting contributions to this project. The CLA process should be as simple as possible (read: low friction).

Resources

CLAHub offers an automated CLA checking service for Github projects.

Fix spaces in URL

Currently API URL uses APIs name to generate URL but the spaces remain in the URL, we have to change that.

Rename project

OpenAPI hub is a bit too similar to Swagger Hub, so we've decided that we should rename the project. Suggestions are welcome.

Create method to list private APIs

Currently when you retrieve the list of APIs by owner, there is no way to list private APIs even while logged in.

Consider re-licensing as EUPL

@ccsr has expressed interest in re-licensing this project as EUPL. This issue is to discuss the licensing question, and to develop a consensus about the project license choice.

Make setup script to look for right pip version

Currently the script only looks for correct python installation but not a correct pip version. There is still some systems which have pip for python2 but not for python3.

Travis tests don't pass at all

When you run travis, all pytest flake8 tests fail with error "AttributeError: 'NoneType' object has no attribute 'config' ". This is most likely due to conflicting package versions, but after playing for quite a bit with different versions i haven't reached any results. Only possible solution canditate so far is related to pytest-flake8 dependency pycodestyle which doesn't work with all the versions (source: PyCQA/pycodestyle#741).

What functionality is needed?
How should the backend be structured?
What tools should we use?

We'll most likely use Flask for the web server and SQLAlchemy for the database. We'll probably also want to use something like connexion or swagger-py-codegen

For the the server architecture, there are currently two main ideas:

A Git-like server where saved specs are immutable, but anyone can create a new revision based on a saved spec. This approach wouldn't require implementing any authentication.
An open-source implementation of the Swagger Hub spec