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/
To get you started you can simply clone the openapi-reporter
repository and install the dependencies:
You need git to clone the openapi-reporter
repository.
You will need Node.js and npm.
Clone the openapi-reporter
repository using git:
git clone https://github.com/systelab/openapi-reporter.git
cd openapi-reporter
To install the dependencies, execute:
npm install
To run the application, execute the following command:
ng serve
To generate the application, execute the following command:
ng build