Skip to content
Snippets Groups Projects
Commit 015d27e4 authored by David Trattnig's avatar David Trattnig
Browse files

Improved intro.

parent 93f9b846
No related branches found
No related tags found
No related merge requests found
# Swagger generated server
# Engine API 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.
The Project serves the Engine API and handles state management of multiple Engine instances.
This project is based on a swagger-enabled Flask server using an *API First* approach. It also uses the [Connexion](https://github.com/zalando/connexion) library on top of Flask.
## Requirements
Python 3.7+
## Usage
## Getting started
To run the server, please execute the following from the root directory:
```
......@@ -18,18 +19,20 @@ pip install -r requirements.txt
python -m src
```
and open your browser to here:
this runs the API in an local development server. You can access the interactive documentation here:
```
http://localhost:8008/AURA-Engine/engine-api/1.0.0/ui/
```
Your Swagger definition lives here:
The OpenAPI 3 specification lives here:
```
http://localhost:8008/AURA-Engine/engine-api/1.0.0/swagger.json
```
## Testing
To launch the integration tests, use tox:
```
sudo pip install tox
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment