Sharing code snippets #298
Replies: 3 comments 2 replies
-
Discord seems better suited for this task. Last week I created a discord server (AnWeber/httpyac#704) => https://discord.gg/eTc4MyRh6P Otherwise, I agree with your opinion that snippets do not necessarily come from the extension, but are best created by the user for their needs. But I already provide some (inital snippets](https://github.com/AnWeber/vscode-httpyac/blob/main/snippets/http.json), but we can improve them. MR are welcome. |
Beta Was this translation helpful? Give feedback.
-
|
I noticed these. I'd like to do a MR, but I'd need to make sure I do not have coding mistakes (I validated the snippet functionality, i.e. tabbing, selections, etc.), but I'm not sure my selection options are all valid. |
Beta Was this translation helpful? Give feedback.
-
|
You can simply place the MR and I'll look over it to see if I notice anything. But I'm a pragmatist. It's not rocket science, if something is wrong, it just gets corrected. |
Beta Was this translation helpful? Give feedback.
-
|
On second thought, I should probably keep this one private because it has code that may not be generic enough. My idea was to try to force people to think about standards and do their APIs in the standard and consistent manner, but I am testing a third party REST API as I write this, and you would not belive how non-sensical some of the APIs from "industry leaders" can be (e.g. using POST to get or update records). But for internal work, I want to standardize: use appropriate method, meaningful HTTP response codes, standar-based errors, etc, so I have more in my snippets than a general user may want to have. It's fine for project-based snippets, since you can fine tune them for the project requirements, but as a global collection, I would probably pass. Could be a good option for sharing on Discord, though. |
Beta Was this translation helpful? Give feedback.
-
|
I agree. At the end of the day, you don't use the general snippets, but the ones that best reflect the patterns used in your own API. That's why I decided to create all snippets myself and avoid general snippet extensions. |
Beta Was this translation helpful? Give feedback.
-
I am helping my team migrate to httpYac and one thing I found useful is code snippets. Since we're moving from Postman, where you just fill out form properties for a request and here you need to type in everything by hand (which is a plus IMHO, but some people need to get used to it), having available code snippets at their fingertips is a must. It would be nice if there were some sort of community exchange place where people could share the things they find useful (if not on GitHub, maybe at Discord? I haven't thought it through, but it would be nice to help user help each other on some platform).
Anyway, here is my first attempt (and I'm not an expert at this point, so there may be some errors, if something does not work or can be improved, please let me know, and feel free to share yours):
This is a file I add to the
.vscodefolder of the project. I named the filehttp.code-snippetsbut it can be named anything, just keep the .code-snippetsextension. Also, make sure it's not ignored in the.gitignoresettings, so it can be checked into a repo and shared with everyone working on the project. To invoke a code snippet, type###or??followed byCTRL+SPACE, then select the snippet from the pop-up menu.{ "Any HTTP request":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for any type of HTTP request.", "body": [ "### ${1:Test title}", "${2:/*\n${3:Optional test description.}\n*/}", "# @name ${4:testResponseName}", "${5:# @ref ${6:referencedTestResponseName}}", "${7:{{\n\t// Skip this test if expected condition from referenced test response is not met.\n\texports.\\$cancel = !$6.${8:expectedCondition};\n\\}\\}}", "${9|GET,POST,PATCH,PUT,DELETE|} /${10:endpoint}", "${11:\t?query=a\n\t&b=c}", "Authorization: ${12|oauth2,Bearer|} ${13|client_credentials,authorization_code,{{bearerToken}}|} ${14:credentialsVariablePrefix}", "${15:Content-Type: application/json}", "${16|{\"a\":\"b\"},[{\"a\":\"b\"}\\,{\"c\":\"d\"}]|}", "", "?? status == ${17|200,201,202,204,400,401,404,409|}", "?? status startsWith ${18|2,4|}", "${0}" ] }, "HTTP GET (ITEM) request":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an HTTP GET request returning a single item.", "body": [ "### ${1:Get sample}", "# @name ${2:sampleJson}", "# @ref ${3:referencedTest}", "GET /${4:endpoint}/{{${5:id}}}", "Authorization: oauth2 client_credentials clientCredentials", "", "?? status == 200", "?? js $2 contains ${6:propertyName}", "?? js $2.$6 ${7|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}", "${0}" ] }, "HTTP GET (ARRAY) request":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an HTTP GET request returning an array.", "body": [ "### ${1:Get samples}", "# @name ${2:samplesJson}", "# @ref ${3:referencedTest}", "GET /${4:endpoint}", "${5:\t?query=a\n\t&b=c}", "Authorization: oauth2 client_credentials clientCredentials", "", "?? status == 200", "?? js $2 isArray", "?? js $2.length > 0", "${0}" ] }, "HTTP POST request":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an HTTP POST request.", "body": [ "### ${1:Create sample}", "# @name ${2:sampleJson}", "# @ref ${3:referencedTest}", "POST /${4:endpoint}", "Authorization: oauth2 client_credentials clientCredentials", "Content-Type: application/json", "{", "${5:\t\"a\":\"b\",\n\t\"c\":\"d\"}", "}", "", "?? status == 201", "?? header Location exists", "?? header Location endsWith {{$2.${6:id}}}", "?? body ${6:responseBodyPropertyName} ${7|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}", "${0}" ] }, "HTTP PUT request":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an HTTP PUT request.", "body": [ "### ${1:Replace sample}", "# @name ${2:sampleJson}", "# @ref ${3:referencedTest}", "POST /${4:endpoint}/{{${5:id}}}", "Authorization: oauth2 client_credentials clientCredentials", "Content-Type: application/json", "{", "\t\"a\":\"b\"", "\t\"c\":\"d\"", "}", "", "?? status == ${6|200,204|}", "?? body ${7:responseBodyPropertyName} ${8|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}", "${0}" ] }, "HTTP PATCH request (JSON-PATCH+JSON)":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an RFC 7396-compliant REST PATCH request with a body holding a single item and application/merge-patch+json content type.", "body": [ "### ${1:Update sample}", "# @name ${2:sampleJson}", "# @ref ${3:referencedTest}", "PATCH /${4:endpoint}/{{${5:id}}}", "Authorization: oauth2 client_credentials clientCredentials", "Content-Type: application/merge-patch+json", "{", "\t\"a\":\"b\",", "\t\"c\":\"d\"", "}", "", "?? status == ${6|200,204|}", "?? body ${7:responseBodyPropertyName} ${8|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}", "${0}" ] }, "HTTP PATCH request (MERGE-PATCH+JSON)":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an RFC 6902-compliant REST PATCH request with a body holding an array of patch operations and application/json-patch+json content type.", "body": [ "### ${1:Test title}", "# @name ${2:sampleJson}", "# @ref ${3:referencedTest}", "PATCH /${4:endpoint}/{{${5:id}}}", "Authorization: oauth2 client_credentials clientCredentials", "Content-Type: application/json-patch+json", "[", "\t{\"op\":\"add\",\"path\":\"/someValue\",\"value\":\"{{newValue}}\"},", "\t{\"op\":\"replace\",\"path\":\"/someOtherValue\",\"value\":\"{{updatedValue}}\"},", "\t{\"op\":\"remove\",\"path\":\"/yetAnotherValue\"}", "]", "", "?? status == ${6|200,204|}", "?? body ${7:responseBodyPropertyName} ${8|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}", "${0}" ] }, "HTTP DELETE request":{ "scope": "http,rest", "prefix": ["###"], "description": "Test region for an HTTP DELETE request.", "body": [ "### ${1:Delete sample}", "# @name ${2:sampleTest}", "# @ref ${3:referencedTestName}", "DELETE /${4:endpoint}/{{${5:id}}}", "Authorization: oauth2 client_credentials clientCredentials", "", "?? status == ${6|202,204|}", "${0}" ] }, "Simple STATUS assetion":{ "scope": "http,rest", "prefix": ["??"], "description": "Validates HTTP response status.", "body": [ "?? status ${1|==,!=,>,>=,<,<=,startsWith,endWith|} ${2|200,201,204,400,401,404,409,20,2,40,4|}" ] }, "Simple BODY assetion":{ "scope": "http,rest", "prefix": ["??"], "description": "Validates a simple property of the HTTP response body against a simple condition.", "body": [ "?? body ${1:testResponsePropertyName} ${2|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}" ] }, "Simple HEADER assetion":{ "scope": "http,rest", "prefix": ["??"], "description": "Validates an HTTP response header against a simple condition.", "body": [ "?? header ${1:responseHeaderName} ${2|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}" ] }, "JavaScript RESPONSE assetion":{ "scope": "http,rest", "prefix": ["??"], "description": "Validates an HTTP response property against a simple or complex condition using JavaScript.", "body": [ "?? js response.${1:parsedBody}.${2:pathToTheProperty} ${3|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}" ] }, "JavaScript BODY assetion":{ "scope": "http,rest", "prefix": ["??"], "description": "Validates a complex property of the HTTP response against a simple or complex condition using JavaScript.", "body": [ "?? js ${1:responseBodyVariableName.propertyName} ${2|exists,isTrue,isFalse,isBoolean,isString,isNumber,sArray,matches ^regex$,== value,!= value,> value,>= value,< value,<= value,startsWith value,endWith value,includes value,contains value|}" ] } }Beta Was this translation helpful? Give feedback.
All reactions