systelab / openapi-reporter

Distributable OpenAPI specifications reports and upload to JAMA Contour

OpenAPI Reporter

OpenAPI reporter will speed up your REST API development by generating documentation from the source code following an Specifications format, as well as JAMA Contour integration to upload the specifications. OpenAPI initiative is a broadly adopted industry standard for describing modern APIs based on a programming language-agnostic interface specifications.

Only supports OpenAPI 3.0 JSON format.

You can find the validated application deployed by Travis at https://systelab.github.io/openapi-reporter/

The test environment is at https://systelab.github.io/openapi-reporter-test/

Getting Started

To get you started you can simply clone the openapi-reporter repository and install the dependencies:

Prerequisites

You need git to clone the openapi-reporter repository.

You will need Node.js and npm.

Clone openapi-reporter

Clone the openapi-reporter repository using git:

git clone https://github.com/systelab/openapi-reporter.git
cd openapi-reporter

Install Dependencies

To install the dependencies, execute:

npm install

Run

To run the application, execute the following command:

ng serve

Generate

To generate the application, execute the following command:

ng build