G-Invoicing

OpenAPI | Swagger UI 

Instructions

Instructional guide for using Swagger UI to view OpenAPI 

specifications for the G-Invoicing JSON based 

RESTful APIs

Version 1.1

February 2023
G-Invoicing OpenAPI | Swagger UI Instructions

2

Table of Contents

Contents

1. Introduction ......................................................................................................................3

1.1. Purpose ....................................................................................................................................................3

1.2. References................................................................................................................................................3

2. Swagger UI........................................................................................................................3

2.1. Swagger UI Tool.......................................................................................................................................3

3. Revision History ...............................................................................................................4
G-Invoicing OpenAPI | Swagger UI Instructions

3 

1. Introduction

1.1. Purpose

G-Invoicing uses the OpenAPI specification to document our JSON based RESTful 

APIs. This document serves as an instructional guide for using the open-source 

Swagger UI tool to visualize our API’s resources and endpoints. 

1.2. References

Information on the OpenAPI specification can be found here: OpenAPI Specification | 

Swagger

Information on the Swagger UI tool can be found here: REST API Documentation Tool 

| Swagger UI

Link to Swagger Editor: Swagger Editor 

2. Swagger UI

2.1. Swagger UI Tool

G-Invoicing will publish OpenAPI specification files for each of the JSON based 

RESTful APIs. The Swagger UI tool can be used to visualize the specification files 

using one of the following two options:

Option 1: 

Using the link provided in the references section, the Swagger UI homepage contains 

a button to launch a ‘live demo’ of the tool. Once launched, you can provide the URL 

of a published OpenAPI specification file in the input box and click the ‘Explore’ button 

to visualize that documentation. 
G-Invoicing OpenAPI | Swagger UI Instructions

4 

Option 2:

The Swagger UI tool can be downloaded from the link provided in the references 

section. Once downloaded, the zip file contains a distribution folder (/dist) that can be 

extracted to the location of your choice. Once extracted, you can launch the 

index.html from the folder with your browser to start using the tool. Once launched, 

you can provide the URL of a published OpenAPI specification file in the input box 

and click the ‘Explore’ button to visualize that documentation.

Option 3:

Use the Swagger Editor at above link. Click File and then JSON file which you want to 

view and Swagger Editor will generate the schema, payloads, and responses. 

3. Revision History

Vers.

Num.

Date of

Change

G-Inv

Rel. Change/Revision Description Page/SectionAffected

1.0 06/29/2022 4.6 First published version All

1.1 02/24/2023 5.0 Included link and Option 3 for Swagger 

Editor

2