jamierpond / yapi
SKILL.md
CLI-first API testing for HTTP, GraphQL, gRPC, and TCP.
Preview
CLI-first API testing for HTTP, GraphQL, gRPC, and TCP.
The Workflow
yapi enables test-driven API development. Write the test first, then implement until it passes:
- Write the test - Create a
.yapi.ymlfile with the expected behavior - Run it -
yapi run file.yapi.yml(it will fail) - Implement/fix - Build the API endpoint
- Iterate - Refine assertions, add edge cases
This loop is the core of agentic API development with yapi.
---
A) Smoke Testing
Quick health checks to verify endpoints are alive.
HTTP
yapi: v1
url: ${url}/health
method: GET
expect:
status: 200GraphQL
yapi: v1
url: ${url}/graphql
graphql: |
query { __typename }
expect:
status: 200
assert:
- .data.__typename != nullgRPC
yapi: v1
url: grpc://${host}:${port}
service: grpc.health.v1.Health
rpc: Check
plaintext: true
body:
service: ""
expect:
status: 200TCP
yapi: v1
url: tcp://${host}:${port}
data: "PING\n"
encoding: text
expect:
status: 200---
B) Integration Testing
Multi-step workflows with data passing between requests. Use chains when steps depend on each other.
SKILL.md