Skip to content
Snippets Groups Projects
README.md 1.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • David Trattnig's avatar
    David Trattnig committed
    # Swagger generated server
    
    ## Overview
    This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the
    [OpenAPI-Spec](https://github.com/swagger-api/swagger-core/wiki) from a remote server, you can easily generate a server stub.  This
    is an example of building a swagger-enabled Flask server.
    
    This example uses the [Connexion](https://github.com/zalando/connexion) library on top of Flask.
    
    ## Requirements
    
    David Trattnig's avatar
    David Trattnig committed
    Python 3.7+
    
    David Trattnig's avatar
    David Trattnig committed
    
    ## Usage
    To run the server, please execute the following from the root directory:
    
    ```
    pip install -r requirements.txt
    python -m src
    ```
    
    and open your browser to here:
    
    ```
    http://localhost:8008/AURA-Engine/engine-api/1.0.0/ui/
    ```
    
    Your Swagger definition lives here:
    
    ```
    http://localhost:8008/AURA-Engine/engine-api/1.0.0/swagger.json
    ```
    
    To launch the integration tests, use tox:
    ```
    sudo pip install tox
    tox
    ```
    
    ## Running with Docker
    
    To run the server on a Docker container, please execute the following from the root directory:
    
    ```bash
    # building the image
    docker build -t src .
    
    # starting up a container
    docker run -p 8008:8008 src
    ```