mirror of
https://github.com/Postman-Devrel/postman-claude-code-plugin.git
synced 2026-04-16 02:02:42 +00:00
add gifs and assets to the README
This commit is contained in:
22
README.md
22
README.md
@@ -1,8 +1,16 @@
|
||||
<p align="center">
|
||||
<img src="https://voyager.postman.com/logo/postman-logo-orange.svg" alt="Postman" width="320">
|
||||
</p>
|
||||
|
||||
# Postman Plugin for Claude Code
|
||||
|
||||
The Postman Plugin provides a single, simple install for Claude Code. It provides full API lifecycle management, and best practices when working with Postman APIs.
|
||||
|
||||
What's included:
|
||||
<p align="center">
|
||||
<img src="assets/postman-plugin-sync.gif" alt="Postman Plugin sync demo" width="800">
|
||||
</p>
|
||||
|
||||
## What's included:
|
||||
- Commands for setting up the Postman MCP Server (no more manual installs!), working with Collections, Tests, Mock Servers, and generating code and documentation from Collections
|
||||
- Skills for Postman Routing, API best practices, and API OWASP security reviews
|
||||
- Agent for reviewing API production readiness and providing recommendations based on the <a href="https://www.postman.com/ai/90-day-ai-readiness-playbook/">Postman API Readiness Guide."</a>
|
||||
@@ -46,6 +54,10 @@ Get your API key at [postman.postman.co/settings/me/api-keys](https://postman.po
|
||||
|
||||
## Commands
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/postman-plugin-codegen.gif" alt="Postman Plugin sync demo" width="800">
|
||||
</p>
|
||||
|
||||
| Command | What It Does |
|
||||
|---------|-------------|
|
||||
| `/postman:setup` | Configure API key, verify connection, select workspace |
|
||||
@@ -59,6 +71,10 @@ Get your API key at [postman.postman.co/settings/me/api-keys](https://postman.po
|
||||
|
||||
## What You Can Do
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/postman-plugin-mock-server.gif" alt="Postman Plugin sync demo" width="800">
|
||||
</p>
|
||||
|
||||
### Sync your API to Postman
|
||||
```
|
||||
"Sync my OpenAPI spec with Postman"
|
||||
@@ -112,6 +128,10 @@ You don't need to remember command names. The plugin's routing skill detects you
|
||||
|
||||
## API Readiness Analyzer
|
||||
|
||||
<p align="center">
|
||||
<img src="assets/postman-plugin-api-ai-check.gif" alt="Postman Plugin sync demo" width="800">
|
||||
</p>
|
||||
|
||||
The built-in readiness analyzer evaluates APIs for AI agent compatibility across 8 pillars:
|
||||
|
||||
| Pillar | What It Checks |
|
||||
|
||||
BIN
assets/postman-plugin-api-ai-check.gif
Normal file
BIN
assets/postman-plugin-api-ai-check.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 MiB |
BIN
assets/postman-plugin-codegen.gif
Normal file
BIN
assets/postman-plugin-codegen.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 32 MiB |
BIN
assets/postman-plugin-mock-server.gif
Normal file
BIN
assets/postman-plugin-mock-server.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 MiB |
BIN
assets/postman-plugin-sync.gif
Normal file
BIN
assets/postman-plugin-sync.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 26 MiB |
Reference in New Issue
Block a user