https://github.com/openapi-json-schema-tools/openapi-document-analysis
A repo to analye usage of some keywords in openapi documents
https://github.com/openapi-json-schema-tools/openapi-document-analysis
Last synced: 2 months ago
JSON representation
A repo to analye usage of some keywords in openapi documents
- Host: GitHub
- URL: https://github.com/openapi-json-schema-tools/openapi-document-analysis
- Owner: openapi-json-schema-tools
- License: mit
- Created: 2023-07-16T16:50:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-27T20:00:06.000Z (about 1 year ago)
- Last Synced: 2025-01-06T14:29:56.488Z (4 months ago)
- Language: Python
- Size: 1.45 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# openapi-document-analysis
A repo to analye usage of some keywords in openapi documents
## openapi documents
documents are from https://github.com/APIs-guru/openapi-directory
## env setup
```
python3 -m venv venv
source venv/bin/activate
pip install pyyaml
```
## usage
- `python analyze.py`
- Outputs md reports and .py files containing required keys and properties keys and qty of usages
- After this is run, the below analyzers can be run on the generated .py files containing key info
- `python analyze_required_keys.py`
- `python analyze_properties_keys.py`
## Reports
- [properties usage](reports/properties_report.md)
- [required usage](reports/required_report.md)
- [required keys python usage](reports/required_keys_python_report.md)
- [properties keys python usage](reports/properties_keys_python_report.md)
- [responses usage](reports/responses_report.md)