scottk/oopt-gnpy-api
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/oopt-gnpy-api.git synced 2025-10-31 01:47:49 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

FIX: correct command example

Browse Source 
Change-Id: Idde1a192532d5a81fa8e3d7bff11c08a96eb0902
This commit is contained in:
Renato Ambrosone
2025-03-27 11:26:55 +01:00
parent fbb3d1dc7a
commit b0bda64b39
1 changed files with 2 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,34 +1,14 @@
# GNPy API # GNPy API
[![Python versions](https://img.shields.io/pypi/pyversions/gnpy)](https://pypi.org/project/gnpy/)
REST API (experimental) REST API (experimental)
----------------------- -----------------------
``gnpyapi`` provides an experimental api for requesting several paths at once. It is based on Flask server. ``gnpyapi`` provides an experimental api for requesting several paths at once. It is based on Flask server.
You can run it through command line or Docker. You can run it through command line or Docker.
.. code-block:: shell-session
$ gnpy-rest
.. code-block:: shell-session
$ docker run -p 8080:8080 -it emmanuelledelfour/gnpy-experimental:candi-1.1 gnpy-rest
When starting the api server will aks for an encryption/decryption key. This key i used to encrypt equipment file when using /api/v1/equipments endpoint.
This key is a Fernet key and can be generated this way:
.. code-block:: python
from cryptography.fernet import Fernet
Fernet.generate_key()
After typing the key, you can detach the container by typing ^P^Q. $ curl --location 'http://localhost:8080/api/v1/path-request' --header 'Content-Type: application/json' --data @gnpyapi/exampledata/planning_demand_example.json
After starting the api server, you can launch a request
.. code-block:: shell-session
$ curl -v -X POST -H "Content-Type: application/json" -d @<PATH_TO_JSON_REQUEST_FILE> https://localhost:8080/api/v1/path-computation -k
TODO: api documentation, unit tests, real WSGI server with trusted certificates TODO: api documentation, unit tests, real WSGI server with trusted certificates