https://github.com/bcdev/xcube-hub
https://github.com/bcdev/xcube-hub
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/bcdev/xcube-hub
- Owner: bcdev
- License: mit
- Created: 2020-05-05T13:55:33.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T23:44:54.000Z (over 2 years ago)
- Last Synced: 2025-09-09T14:15:30.147Z (10 months ago)
- Language: Python
- Size: 33.4 MB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/bcdev/xcube-hub/actions/workflows/xcube-hub_workflow.yaml)
[](https://codecov.io/gh/bcdev/xcube-hub)
# OpenAPI generated server
## Overview
This server was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the
[OpenAPI-Spec](https://openapis.org) from a remote server, you can easily generate a server stub. This
is an example of building a OpenAPI-enabled Flask server.
This example uses the [Connexion](https://github.com/zalando/connexion) library on top of Flask.
## Requirements
Python 3.5.2+
## Usage
To run the server, please execute the following from the root directory:
```
pip3 install -r requirements.txt
python3 -m openapi_server
```
and open your browser to here:
```
http://localhost:8080/api/v2/ui/
```
Your OpenAPI definition lives here:
```
http://localhost:8080/api/v2/openapi.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 openapi_server .
# starting up a container
docker run -p 8080:8080 openapi_server
```