Package: apilyzer
APIlyzerTable of Contents:Description and contextDocumentationPrerequisitesInstallation GuideHow to use?DependenciesHow to contributeTeamLicenseDescription and contextAPIlyzer is a Python library aimed at analyzing the maturity level of REST APIs, following the Richardson maturity model. The goal of this library is to evaluate APIs and generate a report on their maturity level, along with recommendations for improvements so that the API reaches the desired maturity level.Note: The library is still in development, so it does not have all the features we want to implement.DocumentationThe complete documentation, containing all the details of the project, can be accessed at:https://apilyzer.readthedocs.io/en/latest/PrerequisitesMake sure you have Python 3.9 or higher installed on your system before proceeding with the installation.Installation GuideWe recommend creating a virtual environment to install the library in an isolated manner. Follow the commands below for installation:# Create virtual environmentpython-mvenv.venv# Activate virtual environmentsource.venv/bin/activate# Linux.venv\Scripts\activate# Windows# Install the librarypipinstallapilyzerHow to use?APIlyzer offers a command line interface (CLI) for analyzing REST APIs. To know the available commands, run:apilyzerCurrently, there are 3 subcommands available for this application:verify-rest: Checks if a REST API is documented based on the provided URL and if it is, returns the API response.verify-maturity: Analyzes the maturity level of a REST API based on the Richardson maturity model.test-rate: Performs a number of requests (100 by default) to the API with the aim of validating whether the API has a limit for the number of requests.Examples of use:apilyzerverify-resthttps://petstore.swagger.io-ev2/swaggerapilyzerverify-maturityhttps://picpay.github.io/picpay-docs-digital-payments/swagger/checkout.jsonapilyzertest-ratehttps://petstore.swagger.io/v2/petMore information about the CLIFor more information about the CLI, just run the command below:apilyzer--helpFor more information on CLI subcommands, just run the command below:apilyzer<subcommand>--helpDependenciesMain project dependencies:# Production
python = "^3.9"
httpx = "^0.25.0"
typer = "^0.9.0"
rich = "^13.5.2"

# Development
pytest = "^7.4.2"
pytest-cov = "^4.1.0"
blue = "^0.9.1"
isort = "^5.12.0"
taskipy = "^1.12.0"

# Documentation
mkdocs-material = "^9.3.1"
mkdocstrings = "^0.23.0"
mkdocstrings-python = "^1.7.0"How to contributeThere are several ways to contribute to the project, be it with code, tests, documentation, among others. See the project documentation in theDocumentationsection to learn more about how to contribute to the project.TeamAuthorMarco Antônio Martins Porto NettoDevelopersYan SardinhaLicenseMIT LicenseCopyright (c) 2023 Marco Antônio Martins Porto NettoPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.