apilyzer 0.3.0

APIlyzer is a python library that aims to analyze the level of maturity of REST APIs, following the Richardson maturity model

English documentation version in progress...

APIlyzer

Tabela de conteúdos:

• Descrição e contexto
• Documentação
• Guia de instalação
• Como usar?
• Dependências
• Como contribuir
• Equipe
• Licença

Descrição e contexto

O APIlyzer é uma biblioteca python que tem como objetivo analizar o nível de maturidade de APIs REST, seguindo o modelo de maturidade de Richardson. O objetivo da biblioteca é ser capaz de analizar APIs e gerar um relatório com o nível de maturidade da mesma, além de recomendações de melhorias para que a API atinja o nível de maturidade desejado.

Observação: A biblioteca ainda está em desenvolvimento, portanto, não possui todas as funcionalidades que queremos implementar.

Documentação

Acesse a documentação contendo todos os detalhes do projeto em: https://apilyzer.readthedocs.io/en/latest/

Guia de instalação

Para instalar a biblioteca, recomendamos a criação de um ambiente virtual, para que a mesma seja instalada de forma isolada. Para isso, basta executar os comandos abaixo:

Criar ambiente virtual:

python -m venv .venv

Ativar ambiente virtual:

source .venv/bin/activate # Linux
.venv\Scripts\activate # Windows

Instalar a biblioteca:

pip install apilyzer

Como usar?

A biblioteca oferece uma CLI para que você possa analizar APIs REST via linha de comando. Para saber quais são os comandos disponíveis, basta executar o comando abaixo:

apilyzer

Esse comando retornará uma lista com os comandos disponíveis, que no momento são:

apilyzer maturity <url>
apilyzer verify-rest <url>

Onde <url> é a url da API que você deseja analizar, que caso não seja informada, será utilizada a url http://localhost:8000. Por exemplo:

apilyzer verify-rest https://myapi.com

Mais informações sobre o CLI

Para mais informações sobre o CLI, basta executar o comando abaixo:

apilyzer --help

Para mais informações sobre os subcomandos do CLI, basta executar o comando abaixo:

apilyzer <subcomando> --help

Dependências

Principais dependências do projeto:

# Produção
httpx = "^0.25.0"
typer = "^0.9.0"
rich = "^13.5.2"

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

# Documentação
mkdocs-material = "^9.3.1"
mkdocstrings = "^0.23.0"
mkdocstrings-python = "^1.7.0"

Como contribuir

Há várias formas de contribuir com o projeto, com código, testes, documentação, etc. Acesse a documentação do projeto na seção Documentação para saber mais sobre como contribuir com o projeto.

Equipe

Autor

Marco Antônio Martins Porto Netto

Desenvolvedores

Yan Sardinha

Licença

MIT License

Copyright (c) 2023 Marco Antônio Martins Porto Netto

Permission 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.