Support schema in YAML format

Support schema in YAML format

Author: JamalZeynalov

README.md

@@ -36,6 +36,7 @@ pip install swagger-coverage
 ```dotenv
 API_DOCS_TYPE="swagger"  # Note: "openapi" is default type of API docs
 API_DOCS_VERSION="2.0"  # Note: "3.0.0" is default version of API docs
+API_DOCS_FORMAT="yaml"  # Note: "json" is default format of API docs and output files
 ```
 
 ### 3. Add the session-scoped fixture
@@ -79,6 +80,23 @@ def setup_swagger_coverage():
     reporter2.generate_report()
 ```
 
+#### YAML format is also supported:
+
+```python
+import pytest
+from swagger_coverage_py.reporter import CoverageReporter
+
+
+@pytest.fixture(scope="session", autouse=True)
+def setup_swagger_coverage():
+    reporter = CoverageReporter(api_name="petstore", host="https://petstore.swagger.io")
+    reporter.cleanup_input_files()
+    reporter.setup("/v2/swagger.yaml")
+
+    yield
+    reporter.generate_report()
+```
+
 > #### Steps and Parameters:
 > `api_name` - Define the name of the API. This name will be used to find a configuration file.<br>
 > &nbsp;&nbsp;&nbsp;&nbsp; For APIs in this example the files must

requirements.txt

@@ -1,3 +1,6 @@
 requests>=2.25.1
 Faker>=6.0.0
-setuptools>=53.0.0
+setuptools>=53.0.0
+PyYAML~=6.0
+python-dotenv~=0.16.0
+rootpath~=0.1.1

setup.py

@@ -1,11 +1,11 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
 setup(
     name="swagger-coverage",
-    version="2.1.3",
+    version="2.2.0",
     author="Jamal Zeinalov",
     author_email="jamal.zeynalov@gmail.com",
     description='Python adapter for "swagger-coverage" tool',

swagger_coverage_py/configs.py

@@ -1,4 +1,10 @@
 import os
 
+import rootpath
+from dotenv import load_dotenv
+
+load_dotenv(f"{rootpath.detect()}/.env")
+
 API_DOCS_TYPE = os.environ.get("API_DOCS_TYPE", "openapi")  # "swagger"
 API_DOCS_VERSION = os.environ.get("API_DOCS_VERSION", "3.0.0")  # "2.0"
+API_DOCS_FORMAT = os.environ.get("API_DOCS_FORMAT", "json")  # "yaml"

swagger_coverage_py/docs_writers/api_doc_writer.py

@@ -1,11 +1,32 @@
 import json
 
-from swagger_coverage_py.configs import API_DOCS_TYPE
+import requests
+import yaml
 
+from swagger_coverage_py.configs import API_DOCS_FORMAT, API_DOCS_TYPE
 
-def write_api_doc_to_file(file_path: str, api_doc_data: dict):
+
+def __write_api_doc_to_json(file_path: str, api_doc_data: requests.Response):
+    api_doc_data = api_doc_data.json()
     if API_DOCS_TYPE == "swagger" and not api_doc_data.get("swagger", None):
         api_doc_data["swagger"] = "2.0"
 
     with open(file_path, "w+") as file:
         file.write(json.dumps(api_doc_data))
+
+
+def __write_api_doc_to_yaml(file_path: str, api_doc_data: requests.Response):
+    data = yaml.safe_load(str(api_doc_data.text))
+
+    if API_DOCS_TYPE == "swagger" and not data.get("swagger", None):
+        data["swagger"] = "2.0"
+
+    with open(file_path, "w+") as file:
+        file.write(yaml.safe_dump(data, indent=4, sort_keys=False))
+
+
+def write_api_doc_to_file(file_path: str, api_doc_data: requests.Response):
+    if API_DOCS_FORMAT == "json":
+        __write_api_doc_to_json(file_path, api_doc_data)
+    else:
+        __write_api_doc_to_yaml(file_path, api_doc_data)

swagger_coverage_py/reporter.py

@@ -6,13 +6,14 @@
 
 import requests
 
+from swagger_coverage_py.configs import API_DOCS_FORMAT
 from swagger_coverage_py.docs_writers.api_doc_writer import write_api_doc_to_file
 
 
 class CoverageReporter:
     def __init__(self, api_name: str, host: str):
         self.host = host
-        self.swagger_doc_file = f"swagger-doc-{api_name}.json"
+        self.swagger_doc_file = f"swagger-doc-{api_name}.{API_DOCS_FORMAT}"
         self.output_dir = self.__get_output_dir()
         self.ignore_requests = []
         self.swagger_coverage_config = f"swagger-coverage-config-{api_name}.json"
@@ -40,9 +41,8 @@ def setup(
             f"{response.status_code} {response.request.url}"
             f"{response.content}\n{response.content}"
         )
-        swagger_json_data = response.json()
 
-        write_api_doc_to_file(self.swagger_doc_file, swagger_json_data)
+        write_api_doc_to_file(self.swagger_doc_file, response)
 
     def generate_report(self):
         inner_location = "swagger-coverage-commandline/bin/swagger-coverage-commandline"

swagger_coverage_py/results_writers/base_schemas_manager.py

@@ -3,9 +3,11 @@
 import platform
 import re
 
+import yaml
 from faker import Faker
 from requests import Response
 
+from swagger_coverage_py.configs import API_DOCS_FORMAT
 from swagger_coverage_py.uri import URI
 
 
@@ -64,11 +66,18 @@ def write_schema(self):
         ).replace(":", "_")
         path_ = f"swagger-coverage-output/{self.__get_output_subdir()}"
         file_path = f"{path_}/{file_name}".split("?")[0]
-        file_path = f"{file_path} ({rnd}).json"
+        file_path = f"{file_path} ({rnd}).{API_DOCS_FORMAT}"
 
         try:
             with open(file_path, "w+") as file:
-                file.write(json.dumps(schema_dict, indent=4))
+                if API_DOCS_FORMAT == "yaml":
+                    file.write(yaml.safe_dump(schema_dict, indent=4, sort_keys=False))
+                elif API_DOCS_FORMAT == "json":
+                    file.write(json.dumps(schema_dict, indent=4))
+                else:
+                    raise Exception(
+                        f"Unexpected docs format: {API_DOCS_FORMAT}. Valid formats: json, yaml"
+                    )
 
         except FileNotFoundError as e:
             system_ = platform.system()