README.md

API CLI

Make requests to the scoring system and get your API a grade.

Learn more in the doc!

This folder contains the API CLI. The structure is the following:

└─ api-cli/
    └─ code/
      └─ commands/
    └─ config/
    └─ samples/

Once you install this CLI, you will be able to:

• Verify if an API is well-designed.
• Verify an API contract specification (OpenAPI, AsyncAPI, Avro, Protobuf Buffer) or the respective documentation files (Markdown).

⚙️ Installation and usage

1. You can start by cloning this repository:

 git clone git@github.com:InditexTech/api-scoring-engine.git

2. Install the downloaded code dependencies:

npm i

3. Link the 'apicli' command to local installation:

npm link

Then, you can use any of these commands:

• verify, with which you can obtain the score of the API, all along with some helpful information like version numbers or protocol.

• verify-file, verifies an OpenAPI specification file.

• general and command-dedicated help, in case you need further information.

Find more information and output examples in our documentation!