-
Notifications
You must be signed in to change notification settings - Fork 372
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add decorator to simplify creating JSON REST endpoints #473
Open
marcusschiesser
wants to merge
48
commits into
splunk:develop
Choose a base branch
from
marcusschiesser:simplify-writing-json-rest-endpoints
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add decorator to simplify creating JSON REST endpoints #473
marcusschiesser
wants to merge
48
commits into
splunk:develop
from
marcusschiesser:simplify-writing-json-rest-endpoints
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
Test execution with Python v3.10
Test execution with Python v3.10.7
marcusschiesser
force-pushed
the
simplify-writing-json-rest-endpoints
branch
from
December 23, 2022 09:11
1b73120
to
1a0f7d9
Compare
marcusschiesser
force-pushed
the
simplify-writing-json-rest-endpoints
branch
from
December 23, 2022 09:14
1a0f7d9
to
1481673
Compare
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.
Adds the decorator
json_handler
to simplify creating JSON REST endpoints. It automatically adds an exception handler and injects the following parameters to thehandle
method:request
, which isjson.loads(in_string)
query
, which contains the URL parameters as adict
payload
, which contains the payload asdict
(remember to setpassPayload = true
inrestmap.conf
)Here's an example for a GET handler with URL and path parameters:
(Called with something like: http://localhost:8000/en-US/splunkd/__raw/servicesNS/-/{app-name}/myapi/333?param1=4)
And an example for a POST handler (with
passPayload = true
) which processes a JSON payload: