Git Product home page Git Product logo

infoblox-swagger-wapi's Introduction


                        	      Copyright 2021                                            
                  	Author: Vedant Sethia <[email protected]>                         
	For any issues/suggestions please write to Krishna Vasudevan <[email protected]>           

WAPI Documentation using Swagger

Swagger

Swagger is an open-source software framework backed by a large ecosystem of tools that helps developers design, build, document, and consume RESTful web services. While most users identify Swagger by the Swagger UI tool, the Swagger toolset includes support for automated documentation, code generation, and test-case generation. Sponsored by SmartBear Software, Swagger has been a strong supporter of open-source software, and has widespread adoption.

  • swagger-ui-dist is a dependency-free module that includes everything you need to serve Swagger UI in a server-side project, or a single-page application that can't resolve npm module dependencies.

Open-API Specification

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.

Infoblox RESTful APIs

The Infoblox WAPI is an interface based on REST (REpresentational State Transfer). It uses HTTP methods and supports the primary or most-commonly-used HTTP verbs: POST, GET, PUT, and DELETE. These correspond to create, read, update, and delete (or CRUD) operations, respectively. It supports input and output in JSON and XML. All API calls are encrypted using SSL/TLS and authenticated using HTTP basic authentication. These do not depend on any programming language.

Documentation

Pre-requisites

  • Host machine with python 3.0+ and PHP 4.0+ (only for direct installation)
  • Connectivity between Grid master and Host

Installation

Direct Installation
  • [Setup] Download the Infoblox-Swagger-WAPI repository and host it on a server (localhost/domain).
  • [Access] Access this Swagger definition by http://<Host IP-Address/domain>/infoblox-swagger-ui/dist/home.php
Docker

You can pull a pre-built docker image of the Infoblox-Swagger-UI directly from Docker Hub:

docker pull vsethia/infoblox-wapi-swagger:v3
docker run -p <PORT NO>:80 vsethia/infoblox-wapi-swagger:v3

This will start apache with Swagger UI on the specified PORT NO.

You can also create your own image using the Dockerfile given.

docker build Dockerfile -t <username>/<project-name>:<version>

or

docker build . -t <username>/<project-name>:<version>

Instructions

Launch a browser without CORS enforcement (The Infoblox Grid Master does not allow API calls from third party websites like this one) Windows:

C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" --disable-web-security --disable-gpu --ignore-certificate-errors --user-data-dir=~/chromeTemp

Mac OS:

open -n -a /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --args --user-data-dir="/tmp/chrome_dev_test" --disable-web-security --ignore-certificate-errors

Linux:

google-chrome --disable-web-security --ignore-certificate-errors

After accessing "home.php":

  • Enter the Grid Master IP-Address/FQDN and corresponding credentials on the homepage.
  • Select the WAPI version.
  • Click on the button to view the Swagger-UI.

Maintenance

Date: April 6, 2021

  • Added support for WAPI version v2.12 and v2.11.1 released along with NIOS 8.6.
  • Fixed bugs related to SSL verification during documentation generation.
  • Automated the definition generation for WAPI v2.7-v2.12.

infoblox-swagger-wapi's People

Contributors

vedantsethia-infoblox avatar snaqati avatar adityasah0 avatar krisvasudevan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.