Generated API libs

Swagger

Swagger is a framework backed by a large ecosystem of tools that helps developers to work with RESTful Web services. The Swagger toolset includes support for automated documentation, code generation, and test-case generation.

Following files provide OpenAPI files for FRINX ODL’s REST interface (in context of uniconfig topology, unified topology and southbound topology) which can be used with Swagger tools.

How to launch Swagger-UI

  1. Download swagger-uniconfig-4.2.4.frinx.zip (The first download link bellow)

  2. Unzip the file

  3. Go to the directory which you extracted the file in

  4. Run following command in your terminal:

sudo docker run -p 80:8080 -e SWAGGER_JSON=/foo/uniconfig.yaml -v $PWD:/foo swaggerapi/swagger-ui
  1. Open your browser and visit: localhost


UniConfig OpenAPI v2

  • OpenAPI document generated from Uniconfig model + OpenConfig models

Download document here:

https://license.frinx.io/download/swagger-uniconfig-4.2.4.frinx.zip


UniConfig Python and Go clients

  • Client code library, generated from OpenAPI definition, encapsulating REST calls no available for external applications interacting with Uniconfig

Download Python code library:

https://license.frinx.io/download/swagger-uniconfig-python-4.2.4.frinx.zip

Download Go code library:

https://license.frinx.io/download/swagger-uniconfig-go-4.2.4.frinx.zip


Southbound OpenAPI v2

  • OpenAPI document generated from Cli topology + Netconf topology models

Download document here:

https://license.frinx.io/download/swagger-southbound-4.2.4.frinx.zip


Southbound Python and Go clients

  • Client code library, generated from OpenAPI definition, encapsulating REST calls no available for external applications interacting with southbound (cli and netconf topology)

Download Python code library:

https://license.frinx.io/download/swagger-southbound-python-4.2.4.frinx.zip

Download Go code library:

https://license.frinx.io/download/swagger-southbound-go-4.2.4.frinx.zip