Api endpoint generator #494
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…I spec using a Jinja2 template
…resent or the endpoints have /api common base point
…le generated by the endpoint generator script
…point generator script
…er object to accommodate the generated Endpoint file
… to the framework
avinash010
reviewed
Nov 29, 2024
There was a problem hiding this comment.
@shivahari While validating the open api spec for ACC model, I saw the script stopped parsing after it hit the error. Probably we can show an error for the failed endpoint and continue parsing for the next endpoint
| - The json/data params to be passed to the requests method is generated from the request body | ||
| - A Python dictionary collecting all these values is generated | ||
| - Tge generated Python dictionary is redered on a Jinja2 template | ||
|
|
There was a problem hiding this comment.
There is a typo in "The"
| @@ -0,0 +1,100 @@ | |||
| """ | |||
| What does this module do?: | |||
| - It creates an Endpoint file with a class from the OpenAPI spec | |||
| class NameGenerator(): | ||
| "Base class for generating names" | ||
|
|
||
| def __init__(self, |
There was a problem hiding this comment.
Can we have 2 lines after class definition to keep it consistent
avinash010
reviewed
Dec 23, 2024
|
|
||
| # pylint: disable=too-many-branches, too-complex | ||
| def parse_request_body(self, request_body: specification.RequestBody) -> tuple[str, list, str]: | ||
| """ |
There was a problem hiding this comment.
@shivahari : The codacy check is failing due to this pylint issue
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added API Auto Generation capability to the framework. This new change will help generate
*_endpoint.pymodules from anOpenAPI v3.0spec. This partially automates creating API Automation test.Run
python api_auto_generator/endpoint_module_generator.py --helpto getHelpon how to run the generator script.Changes include:
api_auto_generatorto house:make_requestto makeHTTPrequestsrequirements.txtfile to add required modules