Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.64 KB

README.md

File metadata and controls

40 lines (25 loc) · 1.64 KB

Code of conduct

API Scoring System

A microservice, its API, and a CLI.
Reaching the API Design efficiency never was that easy.

Check our doc!


This repository contains the Scoring Service along with its API, responsible for getting a grade for APIs, and a CLI tool called apicli, which makes requests to the scoring system to get your API a score.

You can find further information regarding the API Scoring Suite in our documentation site!


Installation

You can see that in the root of this repository, there is a package/ folder. This folder contains both the microservice package and the CLI package.

To proceed with their installation, please, place yourself in their path and follow the installation guides suggested in the READMEs.


Usage

View the documentation for usage information.


Contributing

Bug reports, proposals of new features, and pull requests are always welcome, so feel free to contribute to the project following the Contributor Covenant code of conduct.