Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rohinivsenthil/postcode
Visual Studio Code extension to create and test simple and complex HTTP/s requests
https://github.com/rohinivsenthil/postcode
api-client api-testing axios developer-tools graphql hacktoberfest request vscode-extension
Last synced: 3 months ago
JSON representation
Visual Studio Code extension to create and test simple and complex HTTP/s requests
- Host: GitHub
- URL: https://github.com/rohinivsenthil/postcode
- Owner: rohinivsenthil
- License: mit
- Created: 2021-05-12T07:07:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-09-27T17:46:02.000Z (about 3 years ago)
- Last Synced: 2024-07-19T02:13:43.814Z (4 months ago)
- Topics: api-client, api-testing, axios, developer-tools, graphql, hacktoberfest, request, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=rohinivsenthil.postcode
- Size: 479 KB
- Stars: 339
- Watchers: 5
- Forks: 30
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Postcode
API client for VS code 📦
Postcode is a [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) that can be used to create and test simple and complex HTTP/s requests, as well as view responses. You can find the extension available [here](https://marketplace.visualstudio.com/items?itemName=rohinivsenthil.postcode).
Release: 1.3.3
## Highlighted Features
- **Intuitive UI/UX** similar to Postman fitting seamlessly with any VSCode theme
- Supports **GraphQL** requests
- Supports **code snippet generation** from requests
## Quick start
**Step 1.** Install the Postcode extension for Visual Studio Code
**Step 2.** Click on the Postcode icon in the side panel OR run the following command **Postcode: Create Request**
**Step 3** Create or test your HTTP/s requests and hit Send to see the responses
## Commands
| Command | Description |
| ------------------------ | ---------------------------------------------------- |
| Postcode: Create Request | Opens a new Postcode tab to create and test requests |
## Issues, feature requests, and contributions
### Issues
- If you come across a problem with the extension, please file an [issue](https://github.com/rohinivsenthil/postcode/issues/new)
- For list of known issues, please check the [issues tab](https://github.com/rohinivsenthil/postcode/issues/new)
### Feature requests
- Find planned features for future releases marked as [feature](https://github.com/rohinivsenthil/postcode/issues?q=is%3Aissue+is%3Aopen+label%3Afeature) under issues tab.
- For new feature requests, please file an [issue](https://github.com/rohinivsenthil/postcode/issues/new)
### Contributions
Contributions are always welcome!
#### Running the extension locally for development
1. Clone the repository and install dependencies by running `yarn install`
2. Press `F5` to open a new window with your extension loaded.
3. Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Postcode: Create Request`.
#### Folder structure
- **`package.json`** - this is the manifest file in which you declare your extension and command. The plugin registers a command and defines its title and command name. With this information VS Code can show the command in the command palette.
- **`webview`**: folder where you will find entire React code
- **`src/extension.ts`**: this is the main file where you will provide the implementation of your command. The file exports one function, `activate`, which is called the very first time your extension is activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`. We pass the function containing the implementation of the command as the second parameter to `registerCommand`.
#### Making changes
- You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
- You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
## Related
- Read the [launch blog](https://rohinivsenthil.medium.com/postcode-vs-code-extension-alternative-to-postman-384816d4cf07) post on Medium
- Featured #11 Product of the day on [Product Hunt](https://www.producthunt.com/posts/postcode)
- Featured in **Trending this week** on Visual Studio Code Marketplace