API Insights scores your API using over 30 tests taken from standards and industry best practices across three categories:
-
Design: how well your API is structured. Is it a well-crafted ship, ready to withstand the rough seas of user demands and scalability?
-
Performance: does your API respond quickly? It's like checking the wind in your sails – are you moving swiftly and smoothly?
-
Security: how safe and secure is your API? It's akin to having a strong hull to protect against the stormy seas of cyber threats.
Get insights into your OpenAPI specifications and API using the Treblle CLI.
The Treblle CLI tool.
Usage:
treblle-cli [command]
Available Commands:
help Help about any command
insights Generate an API Insights report.
Flags:
-h, --help help for treblle
-v, --version version for treblle
Use "treblle-cli [command] --help" for more information about a command.Using homebrew on Mac or Linux, you can install the Treblle CLI using:
brew tap treblle/treblle
brew install treblleYou can use the insights command on the Treblle CLI to upload your OpenAPI Specification to API Insights, and get your report back in just a few seconds.
treblle-cli insights path/to/openapi-spec.jsonYou then have various options available to you. By default you will get an overview of the report, which will allow you to have a high-level overview of your API Insights score. You can also use any of the following options:
Add the --technology flag to see the technology profile discovered on your API.
The --details flag requires one of the following options:
--details=performanceto show the performance tests pass/fail for your API.--details=securityto show the security test pass/fail for your API.--details=qualityto show the quality test pass/fail for your API.--details=allto show the performance, security, and quality test pass/fail for your API.
The --minimum flag gives you the possibility to set a minimum score in CI/CD environments:
--minimum 90to limit any of tests to be at least 90 to pass