[Feature]: Validate JSON from a file? #612

Activity

1. papadeltasierra

   added

   kind/enhancement

   on Jun 29, 2023
2. p1c2u commented on Jul 15, 2023

   

   p1c2u

   on Jul 15, 2023

   Collaborator

   More actions

   @papadeltasierra please check openapi-spec-validator project.
3. pawel-slowik commented on May 28, 2024

   

   pawel-slowik

   on May 28, 2024

   More actions

   Not sure if that's what being asked, but you definitely can validate JSON payloads from files (as opposed to validating the schema itself). All you need to do is to create simple implementations of the request / response protocols, openapi_core.protocols.Request and openapi_core.protocols.Response. Then you can pass your objects to the validate_request and validate_response methods.

   Example:

   from dataclasses import dataclass
   from typing import Mapping, Optional, Any
   from openapi_core import OpenAPI
   from openapi_core.datatypes import RequestParameters
   
   
   @dataclass
   class Request():
       host_url: str
       path: str
       full_url_pattern: str
       method: str
       parameters: RequestParameters
       content_type: str
       body: Optional[bytes]
   
   
   @dataclass
   class Response():
       status_code: int
       content_type: str
       headers: Mapping[str, Any]
       data: Optional[bytes]
   
   
   openapi = OpenAPI.from_file_path("openapi.yaml")
   
   
   request = Request(
       host_url="https://localhost:8000",
       path="/foo/bar",
       full_url_pattern="",
       method="post",
       parameters=RequestParameters(
           header={
               "Authorization": "Bearer whatever",
           }
       ),
       content_type="application/json",
       body=open("request.json", "rb").read(),
   )
   openapi.validate_request(request)
   
   
   ok_response = Response(
       status_code=200,
       content_type="application/json",
       headers={},
       data=open("response_200.json", "rb").read(),
   )
   openapi.validate_response(request, ok_response)
   
   
   error_response = Response(
       status_code=400,
       content_type="application/json",
       headers={},
       data=open("response_400.json", "rb").read(),
   )
   openapi.validate_response(request, error_response)

   ❤️React with ❤️1Reacted by knuth